Packages > pkg.pkl-lang.org/pkl-pantry/pkl.toml

pkl.toml.toml1.0.0

Overview
Properties
Methods
Classes

module pkl.toml.toml

A renderer for TOML configuration files.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.toml@1.0.0#/toml.pkl
Pkl version:: 0.25.0 or higher
Source code:: toml.pkl
Known subtypes:
Known usages:
All versions:

Basic usage:

import "package://pkg.pkl-lang.org/pantry/pkl.toml@1.0.0"

output {
  renderer = new toml.Renderer {}
}

To render TOML dates and times, use Date, Time, and DateTime.

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

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

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

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

function

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

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

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

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

function

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

Returns the value of the property with the given name.

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

function

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

Returns the value of the property with the given name.

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

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

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)
```

Classes

link

abstract class

AbstractDateTime Source
link

class

Date extends AbstractDateTime Source

A TOML Local Date value.
link

class

Time extends AbstractDateTime Source

A TOML Local Time value.
link

class

DateTime extends AbstractDateTime Source

A TOML Offset Date-Time or Local Date-Time value.
link

class

Renderer extends ValueRenderer Source

Renders values as TOML.