syntax (pkl:0.33.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<this> (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: (this) -> 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)
```

Classes

link

class

Parser

Utilities to parse Pkl source code to a syntax tree.
link

class

FormattingRenderer

Renders a Node back to Pkl source code, using the canonical Pkl formatter.
link

class

SExpressionRenderer

Renders a Node as an S-expression.
link

class

Node

A generic, untyped node in the Pkl syntax tree.
link

class

Span

A range of source code, spanning start (inclusive) to end (exclusive).
link

class

SourceLocation

A position in source code, given as a 1-based line and column.

Type Aliases

link

typealias

NodeType = TerminalNodeType|ExprNodeType|TypeNodeType|ObjectMemberNodeType|ClassMemberNodeType|ModuleMemberNodeType|"module"|"doc_comment"|"modifier_list"|"amends_clause"|"extends_clause"|"module_declaration"|"module_definition"|"annotation"|"qualified_identifier"|"import"|"import_alias"|"import_list"|"typealias_header"|"typealias_body"|"class_header"|"class_header_extends"|"class_body"|"class_body_elements"|"method_header"|"method_body"|"class_property_header"|"class_property_header_begin"|"class_property_body"|"object_body"|"object_member_elements"|"parameter"|"type_annotation"|"parameter_list"|"parameter_list_elements"|"type_parameter_list"|"type_parameter_list_elements"|"argument_list"|"argument_list_elements"|"type_argument_list"|"type_argument_list_elements"|"object_parameter_list"|"type_parameter"|"string_constant"|"object_property_header"|"object_property_header_begin"|"object_property_body"|"object_entry_header"|"member_predicate_header"|"when_generator_header"|"for_generator_header"|"for_generator_header_definition"|"for_generator_header_definition_header"|"new_header"|"function_literal_body"|"if_header"|"if_condition"|"if_condition_expr"|"if_then_expr"|"if_else_expr"|"let_parameter_definition"|"let_parameter"|"function_type_parameters"|"parenthesized_type_elements"|"constrained_type_constraint"|"constrained_type_elements"

The kinds of node in the Pkl syntax tree.
link

typealias

TerminalNodeType = "amends_keyword"|"as_keyword"|"class_keyword"|"else_keyword"|"extends_keyword"|"for_keyword"|"function_keyword"|"if_keyword"|"import_keyword"|"import_star_keyword"|"in_keyword"|"let_keyword"|"module_keyword"|"new_keyword"|"out_keyword"|"read_keyword"|"read_question_keyword"|"read_star_keyword"|"super_keyword"|"throw_keyword"|"trace_keyword"|"typealias_keyword"|"when_keyword"|"arrow"|"assign"|"at"|"colon"|"comma"|"dot"|"gt"|"lbrace"|"lbrack"|"lparen"|"lpred"|"lt"|"minus"|"not"|"qspread"|"question"|"rbrace"|"rbrack"|"rparen"|"spread"|"star"|"underscore"|"union"|"interpolation_start"|"string_start"|"string_multi_start"|"string_end"|"string_chars"|"string_newline"|"string_continuation"|"string_escape"|"shebang"|"line_comment"|"block_comment"|"semicolon"|"doc_comment_line"|"identifier"|"modifier"|"operator"|"bool_literal_expr"|"int_literal_expr"|"float_literal_expr"|"this_expr"|"outer_expr"|"module_expr"|"null_expr"|"unknown_type"|"nothing_type"|"module_type"|"this_type"

The NodeTypes that describe a terminal: a node that spans a single token of the grammar, such as a keyword, a punctuation character, an identifier or a literal.

A terminal never has Node.children.
link

typealias

ExprNodeType = "this_expr"|"outer_expr"|"module_expr"|"null_expr"|"throw_expr"|"trace_expr"|"import_expr"|"read_expr"|"new_expr"|"unary_minus_expr"|"logical_not_expr"|"function_literal_expr"|"parenthesized_expr"|"super_subscript_expr"|"super_access_expr"|"subscript_expr"|"qualified_access_expr"|"if_expr"|"let_expr"|"bool_literal_expr"|"int_literal_expr"|"float_literal_expr"|"single_line_string_literal_expr"|"multi_line_string_literal_expr"|"unqualified_access_expr"|"non_null_expr"|"amends_expr"|"binary_op_expr"

The NodeTypes that describe an expression.
link

typealias

TypeNodeType = "unknown_type"|"nothing_type"|"module_type"|"this_type"|"union_type"|"function_type"|"parenthesized_type"|"declared_type"|"nullable_type"|"string_literal_type"|"constrained_type"

The NodeTypes that describe a type.
link

typealias

ObjectMemberNodeType = "object_element"|"object_property"|"object_method"|"member_predicate"|"object_entry"|"object_spread"|"when_generator"|"for_generator"

The NodeTypes that describe a member of an object body.
link

typealias

ClassMemberNodeType = "class_property"|"class_method"

The NodeTypes that describe a member of a class body.
link

typealias

ModuleMemberNodeType = "class_property"|"class_method"|"class"|"typealias"

The NodeTypes that describe a member of a module.

pkl.syntax0.33.0

Properties(show inherited)

Methods(show inherited)

Classes

Type Aliases