Pkldoc > schema.kdeps.com/core

org.kdeps.pkl.Kdeps0.2.17

Properties
Methods
Type Aliases

module org.kdeps.pkl.Kdeps

Abstractions for Kdeps Configuration

Module URI:: package://schema.kdeps.com/core@0.2.17#/deps/pkl/Kdeps.pkl
Pkl version:: 0.28.1 or higher
Source code:: Kdeps.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.
link

runMode: RunMode Source

The mode of execution for Kdeps, defaulting to "docker".
link

dockerGPU: GPU Source

The GPU type to use for Kdeps, defaulting to "cpu".
link

kdepsDir: String Source

The directory where Kdeps files are stored, defaulting to ".kdeps".
link

kdepsPath: Path Source

The path where Kdeps configurations are stored, defaulting to "user".

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)
```

Type Aliases

link

typealias

GPU = "nvidia"|"amd"|"cpu"Source

Defines the types of GPU available for Kdeps configurations.
link

typealias

RunMode = "docker"Source

Defines the mode of execution for Kdeps.
link

typealias

Path = "user"|"project"|"xdg"Source

Defines the paths where Kdeps configurations can be stored.