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

Renderer1.0.3

Properties
Methods

class Renderer extends ValueRenderer

Renders values as TOML.

Known subtypes in package:
Known usages in package:
All versions:

Properties(show inherited)

link

converters: Mapping<(Class|String), (unknown) -> Any>Source

Value converters to apply before values are rendered.

For further information see PcfRenderer.converters. For path converters, only "*" is supported.
link

BaseValueRenderer.convertPropertyTransformers: Mapping<Class, Mixin<ConvertProperty>> (pkl.base)Source

Customizations for ConvertProperty annotation behaviors.

This property is consulted to transform ConvertProperty annotation values. This can be used to customize or override the conversion behavior for a specific renderer. If multiple entries match the annotation's class, the most specific class (according to class hierarchy) wins.

See ConvertProperty for detailed information.
link

BaseValueRenderer.extension: String? (pkl.base)Source

The file extension associated with this output format, or null if this format does not have an extension.

Methods(show inherited)

link

function

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

Returns the class of this.
link

function

Any.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

Any.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

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

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

function

Typed.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

Typed.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

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

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function

renderDocument(value: Any): unknownSource

Renders value as a complete document.

Some renderers impose restrictions on which types of values can be rendered as document.

A typical implementation of this method renders a document header/footer and otherwise delegates to renderValue().
link

function

renderValue(value: Any): unknownSource

Renders value.