Packages > pkg.pkl-lang.org/pkl-swift/pkl.swift > pkl.swift.swift

Module0.4.0

Overview
Properties
Methods

class Module extends Annotation

Metadata for the corresponding Swift module for the annotated Pkl module(s).

Known subtypes:
Known usages:
All versions:: 0.4.1, 0.4.0, 0.3.0, 0.2.3

This flag

Example:

@swift.Module { name = "MyLibrary" }
module myteam.myproj.MyLibrary

import "package://pkg.pkl-lang.org/pkl-swift/pkl.swift@<VERSION>#/swift.pkl"

Properties

link

name: SwiftName Source

The full name of the Swift module

Methods(show inherited)

link

function

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

Returns the class of this.
link

function

Any.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

Any.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

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

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

function

Typed.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

Typed.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

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

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.