Packages > pkl > pkl.syntax

FormattingRenderer0.33.0

Properties
Methods

class FormattingRenderer

Renders a Node back to Pkl source code, using the canonical Pkl formatter.

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

Properties

link

grammarVersion: "V1"|"V2"

The grammar version to target.

"V1" matches Pkl 0.25 - 0.29, "V2" matches Pkl 0.30+.

Methods(show inherited)

link

function

Any.getClass(): Class<this> (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: (this) -> 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

renderValue(node: Node): String

Render node as Pkl source code.