Packages > pkl > pkl.Command

Argument0.31.0

Properties
Methods

class Argument extends Annotation

Annotates an options property to configure it as a positional CLI argument.

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

convert: (String) -> Any?

Customize the behavior of turning the raw option values string into the final value.

When the return value is an Import value or a Pair member, List or Set element containing an Import, the URI or glob URI specified by the value is imported and the value is replaced with the value of the imported module(s).

If no value is provided, each option value is transformed using the same rules as Flag.convert.
link

multiple: Boolean?

Specifies whether the argument may be specified more than once.

If not specified, this is determined based on the option's type. Options with type Listing, List, Set, Mapping, or Map are multiple by default. Overriding this behavior generally requires setting convert and/or transformAll.

Only one argument per command may be multiple.
link

transformAll: (List<Any>) -> Any?

Customize the behavior of turning all parsed flag values into the final option value.

When the return value is an Import value or a Pair member, List or Set element containing an Import, the URI or glob URI specified by the value is imported and the value is replaced with the value of the imported module(s).

If no value is provided, all option values are transformed using the same rules as Flag.transformAll.
link

completionCandidates: "paths"|Listing<String>(isDistinct)

Specify how this flag should be completed in generated shell completions.

If set to "paths", the completion candidates will be local file paths. If set to a Listing, the completion candidates will be the specified literal strings.

Options with a string literal union type use the members of the union as completion candidates by default.

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.