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

Renderer1.1.1

Properties
Methods

class Renderer extends ValueRenderer

Renders values as Lua.

Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

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

Value converters to apply before values are rendered.

For more information see ValueRenderer.converters. Note that due to language limitations, when rendering a Dynamic, any entries with a String key will have converters applied as though the entry was a property. This means paths like x[foo] only apply when rendering a Mapping, or when a class converter converts an entry key into a String.
link

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

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

indent: String Source

The characters to use for indenting output. Defaults to two spaces.
link

omitNullProperties: Boolean Source

Whether to skip rendering properties whose value is null.

Note that due to language limitations, any entries in a Dynamic will be treated as properties.
link

multilineThreshold: Int Source

The number of elements in a Mapping or Listing to render them multiline.

The default value of 2 means a collection with a single element will be rendered in the inline style, although any nested collections may be rendered in the multiline style.

Note that Map and List are always rendered in the inline style.

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): String Source

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): String Source

Renders value.