Pkldoc > schema.kdeps.com/core

org.kdeps.pkl.Item0.4.1-pkldocs

Overview
Properties
Methods

open module org.kdeps.pkl.Item

Abstractions for managing records in a for loop

Module URI:: package://schema.kdeps.com/core@0.4.1-pkldocs#/deps/pkl/Item.pkl
Pkl version:: 0.29.1 or higher
Source code:: Item.pkl
Known subtypes:
Known usages:
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

current(): String Source

Retrieves the record for the current iteration

Returns the textual content of the most recent loop record, or an empty string if no record is found.
link

function

prev(): String Source

Retrieves the record for the previous iteration

Returns the textual content of the previous loop record, or an empty string if no previous record exists.
link

function

next(): String Source

Retrieves the record for the next iteration

Returns the textual content of the next loop record, or an empty string if no next record exists.
link

function

values(id: String): Listing<String>Source

Lists all record results associated with the for loop

Returns a textual representation of all loop records, or an empty string if no records are found.