Packages > pkl > pkl.base

ModuleOutput0.27.0

Properties
Methods

class ModuleOutput extends FileOutput

The contents and appearance of a module's output.

Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

FileOutput.value: Any? (pkl.base)

The value to render.
link

FileOutput.renderer: ValueRenderer (pkl.base)

The renderer for value.
link

FileOutput.text: String (pkl.base)

The final rendered output.
link
files: Mapping<String, FileOutput>?

The files to be produced by this module when rendering in multiple file output mode.
Keys determine file paths, and may include subdirectories. FileOutput.text determines file contents.

Example:
```
output {
  files {
    ["foo/bar.yml"] {
      value = new { bar = "bar" }
      renderer = new YamlRenderer {}
    }
  }
}
```
A file can be set to the output of another module. For example:
```
output {
  files {
    ["foo.yml"] = import("foo.pkl").output
  }
}
```

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.