Packages > pkl > pkl.Command

Flag0.31.0

Properties
Methods

class Flag extends BaseFlag

Annotates an options property to configure it as a named CLI flag that accepts a value.

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

Properties(show inherited)

link

BaseFlag.shortName: Char? (pkl.Command)

Abbreviated flag name.
link

BaseFlag.hide: Boolean (pkl.Command)

Hide this option from CLI help.
link

metavar: String?

Text to use in place of the option value in CLI help.

If not specified, the value is derived from the flag's type.

link

convert: (String) -> Any?

Customize the behavior of parsing the raw option values.

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 transform is provided, the raw flag value are parsed according to the option's type:

Type	Behavior
`String`	Value is used verbatim
`Char`	Value is used verbatim; must be exactly one character
`Boolean`	True values: `true`, `t`, `1`, `yes`, `y`, `on`; False values: `false`, `f`, `0`, `no`, `n`, `off`
`Number`	Value is parsed as an `Int` if possible, otherwise parsed as `Float`
`Float`	Value is parsed as a `Float`
`Int`	Value is parsed as an `Int`
`Int8`, `Int16`, `Int32`, `UInt`, `UInt8`, `UInt16`, `UInt32`	Value is parsed as an `Int` and must be within the type's range
Union of `String` literals	Value is used verbatim; must match a member of the union
`Listing`, `List`, `Set`	Element values are parsed based on the above primitive types
`Mapping`, `Map`, `Pair`	Value is split into a `Pair` on the first `"="` and each substring is parsed based on the above primitive types
Other types	An error is thrown; `convert` should be defined explicitly

link

multiple: Boolean?

Specifies whether the flag 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 mulitple by default. Overriding this behavior generally requires setting convert and/or transformAll.

link

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

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

If no value is provided, all flag values are transformed according to the option's type:

Type	Behavior
`Mapping`, `Map`	Each value must be a `Pair`, each pair becomes an entry in the result.
`Listing`, `List`	Result is all option values in the order specified
`Set`	Result is all unique option values
Other types	Result is the last value specified option value

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.