xml (pkl:0.31.0) • Packages

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
Element(_name: String(!isEmpty)): Dynamic

Creates an XML element with the given name.
Use this method to directly define an XML element instead of relying on the default rendering of Pkl values.

To define the XML element's attributes, set the attributes property of the Element object:
```
order = xml.Element("order") {
  attributes {
    ["date"] = "2020-03-21"
  }
}
```
To define the XML element's content, add child values (normally also called "elements") to the Element object:
```
order = (xml.Element("order")) {       // element with one child
  (xml.Element("item")) {              // element with two children
    (xml.Element("name")) { "banana" } // element with one child
    (xml.Element("quantity")) { 42 }   // element with one child
  }
}
```
link

function

Inline(_value: Object|Collection|Map): Inline

Creates an Inline directive for _value.
link

function

Comment(_text: String): Comment

Creates an XML Comment with the given _text.
link

function

CData(_text: String): CData

Creates an XML CData section with the given _text.

Classes

link

class

Renderer extends ValueRenderer

Renders values as XML.
link

class

Property extends ConvertProperty

Annotate properties of classes and modules with this class to override how a Renderer interprets a property's name.
link

class

Inline

Inlines the members of value into the enclosing XML element, without rendering an XML element for value itself.
link

class

Comment

An XML comment.
link

class

CData

An XML CDATA section.

pkl.xml0.31.0

Properties(show inherited)

Methods(show inherited)

Classes