Packages > pkl > pkl.base

Module0.26.0

Properties
Methods

abstract external class Module

Base class for modules.

Known subtypes:: BaseParameter, Benchmark, Components, Config, Configuration, Contact, CpuInput, CsvInputDataFormat, DiscardOutput, DiskInput, DocPackageInfo, DocsiteInfo, Document, Encoding, EvaluatorSettings, Example, ExecInput, ExternalDocs, FileInput, FileOutput, HTTPResponse, Header, HttpInput, Info, Input, InputDataFormat, JsonInputDataFormat, JsonOutputDataFormat, JsonSchema, License, Link, MediaType, ModulesGenerator, NetInput, OAuthFlows, OpenTelemetry, Operation, Output, OutputDataFormat, Parameter, Parser, PathItem, Plugin, Processor, Project, PrometheusClientOutput, PrometheusInput, PrometheusObject, PropertySchema, Reference, RequestBody, Response, Rule, Schema, SchemaGenerator, Security, SecurityScheme, Server, ServerVariable, SocketListenerInput, SolrInput, StarlarkProcessor, Tag, TailInput, Telegraf, Type, URI, base, convert, expressions, generate, generate, json, json, jsonnet, lua, math, net, platform, protobuf, reflect, release, semver, settings, shell, shellshortcuts, test, text, u128, utils, xml, yaml, yaml
Known usages:
All versions:: 0.29.0-dev, 0.28.1, 0.28.0, 0.28.0-dev, 0.27.2, 0.27.1, 0.27.0, 0.26.3, 0.26.2, 0.26.1, 0.26.0, 0.25.3, 0.25.2, 0.25.1, 0.25.0-dev

Properties

link

hidden

output: ModuleOutput

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String>

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```