Packages > pkl > pkl.base

ModuleInfo0.26.3

Overview
Properties
Methods

class ModuleInfo extends Annotation

Metadata for a module.

Known subtypes:
Known usages:
All versions:

To annotate a module, place the annotation before the module, amends, or extends keyword, whichever comes first.

@ModuleInfo { minPklVersion = "1.2.3"; author = "author@apple.com" }
module myModule

All library modules should have a ModuleInfo annotation.

Properties

link

minPklVersion: String(matches(Regex(#"\d{1,2}\.\d{1,2}\.\d{1,2}"#)))

The minimum Pkl version required by this module.

The expected format is "major.minor.patch".

This version constraint is enforced by the Pkl runtime.

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

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

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

function

Typed.getProperty(name: String): unknown (pkl.base)

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)

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)

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.