Packages > pkl > pkl.yaml

Property0.31.0

Properties
Methods

class Property extends ConvertProperty

Annotate properties of classes and modules with this class to override how a YamlRenderer interprets a property's name.

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

Properties(show inherited)

link

ConvertProperty.render: (Pair<String, Any>, BaseValueRenderer) -> Pair<String, Any> (pkl.base)Source

Function called by BaseValueRenderer types during rendering to transform property names and values.
link

name: String

The new name to use for the annotated property when rendered by YamlRenderer.

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.