Packages > pkg.pkl-lang.org/pkl-pantry/pkl.experimental.syntax

pkl.experimental.syntax.ExpressionNode1.0.0

Properties
Methods
Classes
Type Aliases

abstract module pkl.experimental.syntax.ExpressionNode extends pkl.experimental.syntax.Node

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/ExpressionNode.pkl
Source code:: ExpressionNode.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

hidden

pcfRenderer: ValueRenderer (pkl.experimental.syntax.Node)Source
link

hidden

indent: String (pkl.experimental.syntax.Node)Source

The indentation when rendering.
link

hidden

maxColumnWidth: Int (pkl.experimental.syntax.Node)Source

The max column width to use when rendering.

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

abstract function

render(currentIndent: String): String (pkl.experimental.syntax.Node)Source
link

function

parenthesize(str: String): unknown (pkl.experimental.syntax.Node)Source

Classes

link

class

BinaryOperatorExpressionNode extends ExpressionNode Source
link

class

BuiltInKeywordExpressionNode extends ExpressionNode Source
link

class

PrefixOperatorExpressionNode extends ExpressionNode Source

Unary operators in the prefix position: "!" and "-".
link

class

PostfixOperatorExpressionNode extends ExpressionNode Source

Unary operators in the postfix position: "!!"
link

class

MemberAccessExpressionNode extends ExpressionNode Source
link

class

QualifiedMemberAccessExpressionNode extends ExpressionNode Source

Can either be an identifer or a function call.
link

class

SuperAccessExpressionNode extends ExpressionNode Source
link

class

SuperSubscriptExpressionNode extends ExpressionNode Source
link

class

SubscriptExpressionNode extends ExpressionNode Source
link

class

LiteralValueExpressionNode extends ExpressionNode Source

Node representing a literal value; e.g. true and "hello".
link

class

ObjectExpressionNode extends ExpressionNode Source

Node representing new { ... } or new Type { ... }.
link

class

IfElseExpressionNode extends ExpressionNode Source

if (...) ... else ...
link

class

ImportExpressionNode extends ExpressionNode Source
link

class

ReadExpressionNode extends ExpressionNode Source
link

class

TraceExpressionNode extends ExpressionNode Source
link

class

StringExpressionNode extends ExpressionNode Source

Provides interpolation and multi-line strings that are not available using LiteralValueExpressionNode.

Type Aliases

link

typealias

CompoundExpressionNode = BinaryOperatorExpressionNode|PrefixOperatorExpressionNode|IfElseExpressionNode Source