Packages > pkl > pkl.base

SourceCode0.27.0

Properties
Methods

class SourceCode extends Annotation

Indicates that the annotated property's string value contains source code written in language.

Known subtypes:
Known usages:
All versions:

Properties

link
language: "Go"|"HTML"|"Java"|"JavaScript"|"Markdown"|"Pkl"|"PklExpr"|"Python"|"Ruby"|"SQL"|"Swift"|String

The language that the source code is written in.
Examples:
- "x = 42" is valid source code for language "Pkl".
- "42" is valid source code for language "PklExpr".
- "42" is valid source code for language "Pkl" with prefix "x = ".
link

prefix: String?

A source code prefix to help tools understand the source code.

For example, an expression may not be considered valid unless wrapped in a statement.
link

suffix: String?

A source code suffix to help tools understand the source code.

For example, an expression may not be considered valid unless wrapped in a statement.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

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

Typed.hasProperty(name: String): Boolean (pkl.base)

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)

Converts this object to a Map.