reflect (pkl:0.25.2) • 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.
link

anyType: DeclaredType

A mirror for the Any type.
link

booleanType: DeclaredType

A mirror for the Boolean type.
link

intType: DeclaredType

A mirror for the Int type.
link

int8Type: DeclaredType

A mirror for the Int8 type.
link

int16Type: DeclaredType

A mirror for the Int16 type.
link

int32Type: DeclaredType

A mirror for the Int32 type.
link

uintType: DeclaredType

A mirror for the UInt type.
link

uint8Type: DeclaredType

A mirror for the UInt8 type.
link

uint16Type: DeclaredType

A mirror for the UInt16 type.
link

uint32Type: DeclaredType

A mirror for the UInt32 type.
link

floatType: DeclaredType

A mirror for the Float type.
link

stringType: DeclaredType

A mirror for the String type.
link

durationType: DeclaredType

A mirror for the Duration type.
link

dataSizeType: DeclaredType

A mirror for the DataSize type.
link

pairType: DeclaredType

A mirror for the Pair<unknown, unknown> type.
link

listType: DeclaredType

A mirror for the List<unknown> type.
link

setType: DeclaredType

A mirror for the Set<unknown> type.
link

mapType: DeclaredType

A mirror for the Map<unknown, unknown> type.
link

objectType: DeclaredType

A mirror for the Object type.
link

dynamicType: DeclaredType

A mirror for the Dynamic type.
link

typedType: DeclaredType

A mirror for the Typed type.
link

listingType: DeclaredType

A mirror for the Listing<unknown> type.
link

mappingType: DeclaredType

A mirror for the Mapping<unknown, unknown> type.
link

moduleType: ModuleType

A mirror for the module type.
link

unknownType: UnknownType

A mirror for the unknown type.
link

nothingType: NothingType

A mirror for the nothing type.

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
Module(mod: Module): Module

Returns a mirror for mod.
When a module is amended like an object, it is no longer a module. In this case, Module() throws. In the following example, barnOwl is such an object, created by amending the module pigeon.pkl.
```
barnOwl = import("pigeon.pkl") {
  name = "Barn Owl"
}
```
link

function
moduleOf(mod: Module): Module

Returns a mirror mod if it is a module, and otherwise its closest parent that is a module.
When a module is amended like an object, it is no longer a module. In this case, moduleOf() returns a mirror of the closest parent that is. In the following example, barnOwl is such an object, created by amending the module pigeon.pkl.
```
barnOwl = import("pigeon.pkl") {
  name = "Barn Owl"
}
```
link

function

Class(clazz: Class): Class

Returns a mirror for clazz.
link

function

TypeAlias(typeAlias: TypeAlias): TypeAlias

Returns a mirror for typeAlias.
link

function

DeclaredType(referent: TypeDeclaration): DeclaredType

Returns a mirror for the declared type for referent.
link

function

FunctionType(parameterTypes: List<Type>, returnType: Type): FunctionType

Returns a mirror for the function type with the given parameterTypes and returnType.
link

function

StringLiteralType(value: String): StringLiteralType

Returns a mirror for the string literal type for value.
link

function

UnionType(memberTypes: List<Type>): UnionType

Returns a mirror for the union of memberTypes.
link

function

TypeVariable(referent: TypeParameter): TypeVariable

Returns a mirror for a type variable for referent.

Classes

link

abstract external class

Declaration

A program declaration.
link

external class

Module extends Declaration

A module declaration.
link

abstract external class

TypeDeclaration extends Declaration

A class or type alias declaration.
link

external class

Class extends TypeDeclaration

A class declaration.
link

external class

TypeAlias extends TypeDeclaration

A type alias declaration.
link

external class

Property extends Declaration

A property declaration.
link

external class

Method extends Declaration

A method declaration.
link

external class

MethodParameter

A method parameter.
link

external class

TypeParameter

A type parameter of a generic type or method declaration.
link

abstract external class

Type

A type as it occurs, say, in a type annotation.
link

external class

DeclaredType extends Type

A declared type such as String or Listing<String>.
link

external class

StringLiteralType extends Type

A string literal type such as "Pigeon".
link

external class

UnionType extends Type

A union type such as String|Int.
link

external class

NullableType extends Type

A nullable type such as String?.
link

external class

FunctionType extends Type

A function type such as (String, Int) -> Duration.
link

class

ModuleType extends Type

The module type.
link

class

UnknownType extends Type

The unknown type.
link

class

NothingType extends Type

The nothing type.
link

external class

TypeVariable extends Type

A type variable that refers to a type parameter of a generic type or method declaration.
link

external class

SourceLocation

A source location within a module.

Type Aliases

link

typealias

Modifier = "abstract"|"external"|"hidden"|"open"

A modifier of a Declaration.
link

typealias

Variance = "in"|"out"

The variance of a TypeParameter.

An "in" type parameter is contravariant. An "out" type parameter is covariant.

pkl.reflect0.25.2

Properties(show inherited)

Methods(show inherited)

Classes

Type Aliases