Packages > pkl

pkl.semver0.28.1

Properties
Methods
Classes

module pkl.semver

Parsing, comparison, and manipulation of semantic version numbers.

Module URI:: pkl:semver
Pkl version:: 0.28.1 or higher
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

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

comparator: (Version, Version) -> Boolean

A version comparator for use with methods such as List.minWith().

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

isValid(version: String): unknown

Tells whether version is a valid semantic version number.
link

function
Version(version: String): Version

Parses version as a semantic version number.
Throws if version is not a valid semantic version number.

Examples:
```
semver.Version("1.2.3")
semver.Version("1.2.3-alpha")
semver.Version("1.2.3+456")
semver.Version("1.2.3-alpha+456")
```
link

function
parseOrNull(version: String): Version?

Parses version as a semantic version number.
Returns null if version is not a valid semantic version number.

Facts:
```
semver.parseOrNull("1.2.3") == semver.Version("1.2.3")
semver.parseOrNull("1.2.3-alpha+456") == semver.Version("1.2.3-alpha+456")
semver.parseOrNull("1") == null
```

Classes

link

class

Version

A semantic version.