Packages > pkl > pkl.base

Deprecated0.27.0

Properties
Methods

class Deprecated extends Annotation

Indicates that the annotated member is deprecated and will likely be removed in the future.

Known subtypes:
Known usages:
All versions:

Properties

link

since: String?

The version in which the annotated member became deprecated.
link

message: String?

A message explaining how to deal with the deprecation.

The message may contain member links, should end with a period, and should not contain line breaks.

Example: "Use [String.codePoints] instead."

link

replaceWith: String?

The code fragment to replace usages of the deprecated member with.

Setting this property instructs tools to automatically replace usages of the deprecated member. For human instructions, use message.

Examples:

// replace usages of a deprecated class or type alias with `Inventory`
replaceWith = "Inventory"
// replace usages of a deprecated property or method with `inventory`
replaceWith = "inventory"
// replace usages of a deprecated property or method with `store.inventory`
// and an import of `store`, which must resolve to an import of the current module
replaceWith = "store.inventory"
// replace usages of a deprecated property or method with `order(42)`
replaceWith = "order(42)"
// replace usages of a deprecated method (that has a parameter named `amount`) with `order(amount)`
replaceWith = "order(amount)"

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.