Packages > pkl

pkl.ref0.32.0

Overview
Properties
Methods
Classes

module pkl.ref

Type-safe deferred references to values not known at evaluation time.

Module URI:: pkl:ref
Pkl version:: 0.32.0 or higher
Known subtypes in package:
Known usages in package:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function
Reference<D, T>(domain: D(this is Domain), class: Class, data: Any): Reference<D, T>

Creates a deferred Reference to a value of type class in the given domain and data.
References may only be constructed for single, non-generic class types. To create a reference to other types (generic classes, union, nullable, constrained, typealiases, etc.), use a wrapper class with a property of the desired type.

Example:
```
myReference: Reference<MyDomain, Listing<String>> = Reference(domain, Holder, data).$

class Holder {
  $: Listing<String>
}
```

Classes

link

external class

Reference<out D, out T>

References are an advanced API design tool that enables library authors to express domain-specific values, whose actual underlying values are not known to Pkl during evaluation.
link

abstract class

Domain

A configuration domain that a Reference may exist within.
link

class

Access

A property or subscript access as part of a Reference's path.