Dynamic0.28.1

Overview
Properties
Methods

class Dynamic extends Object

An object that can contain arbitrary properties, elements, and entries.

Known subtypes:
Known usages:
All versions:: 0.29.0-dev, 0.28.1, 0.28.0, 0.28.0-dev, 0.27.2, 0.27.1, 0.27.0, 0.26.3, 0.26.2, 0.26.1, 0.26.0, 0.25.3, 0.25.2, 0.25.1, 0.25.0-dev

Example:

obj = new Dynamic {
  propertyName = "propertyValue"
  "element"
  ["entryKey"] = "entryValue"
}

Unlike a Typed object, a dynamic object does not have an associated class describing its shape.

Properties

link

hidden

default: (unknown) -> Any

The function used to compute the default value for an object element or entry given its key.

Methods(show inherited)

link

function

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

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

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)

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

length(): Int

Returns the number of elements in this object.
link

function

hasProperty(name: String): Boolean

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

function

getProperty(name: String): unknown

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

Returns the value of the property with the given name.

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

function

toMap(): Map<unknown, unknown>

Converts the properties and/or entries of this dynamic object to a Map.
link

function

toList(): List<unknown>

Converts the elements of this dynamic object to a List.
link

function
toTyped<Type>(clazz: Class): Type(this is Typed)

Converts this object to a typed object of class clazz.
Conforms to the semantics of the following manual conversion:
```
class Person { name: String; age: Int }
dynamic = new Dynamic { name = "Pigeon"; age = 42 }
function toTyped(dynamic: Dynamic): Person = new {
  name = dynamic.getPropertyOrNull("name") ?? super.name
  age = dynamic.getPropertyOrNull("age") ?? super.age
}
```
Notable behavior:
- Elements and entries of this are ignored.
- Properties of this that have no corresponding property in clazz are ignored.
- clazz properties that have no corresponding property in this have their defaults preserved.
- clazz properties that have neither a default nor a corresponding property in this throw an "undefined property" error (only) when accessed.
Throws if clazz is abstract or not a subclass of Typed.