Packages > pkg.pkl-lang.org/pkl-pantry/pkl.lua

pkl.lua.lua1.1.0

Properties
Methods
Classes
Type Aliases

module pkl.lua.lua

A Parser and Renderer for a subset of Lua.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.lua@1.1.0#/lua.pkl
Pkl version:: 0.25.0 or higher
Source code:: lua.pkl
Known subtypes:
Known usages:
All versions:: 1.1.1, 1.1.0, 1.0.1, 1.0.0

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

Classes

link

class

RenderDirective Source

Directs Renderer to output additional text before and/or after rendering a value.
link

class

Renderer extends ValueRenderer Source

Renders values as Lua.
link

class

Parser Source

A parser for a strict subset of Lua.

Type Aliases

link

typealias

Keyword = "and"|"break"|"do"|"else"|"elseif"|"end"|"false"|"for"|"function"|"goto"|"if"|"in"|"local"|"nil"|"not"|"or"|"repeat"|"return"|"then"|"true"|"until"|"while"Source

A string that is a Lua reserved keyword.

Also known as:

LuaKeyword

These strings are not allowed to be used as identifiers.
link

typealias

LuaKeyword = Keyword Source

Deprecated:
Use Keyword instead.
Replace with: lua.Keyword

Obsolete alias for Keyword.
link

typealias

Identifier = String(matches(Regex("[a-zA-Z_][a-zA-Z0-9_]*")) && !(this is lua.Keyword))Source

A string that is a valid Lua identifier.

Also known as:

LuaIdentifier
link

typealias

LuaIdentifier = Identifier Source

Deprecated:
Use Identifier instead.
Replace with: lua.Identifier

Obsolete alias for Identifier.
link

typealias

Value = Null|Boolean|Number|String|Listing|Dynamic|Mapping Source

Pkl representation of a Lua value.
link

typealias

TableKey = Boolean|Number(!isNaN)|String|Listing|Dynamic|Mapping Source

Pkl representation of a valid Lua table key.
link

typealias

LuaRenderDirective = RenderDirective Source

Deprecated:
Use RenderDirective instead.
Replace with: lua.RenderDirective

Obsolete alias for RenderDirective.