Positional
Defined in: packages/input/dist/index.d.mts:172
A positional argument.
Type Parameters
Section titled “Type Parameters”TKind extends Kind
TRequired
Section titled “TRequired”TRequired extends boolean = true
TList extends boolean = false
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Positional<
TKind,TRequired,TList>(kind):Positional<TKind,TRequired,TList>
Defined in: packages/input/dist/index.d.mts:197
Creates a new positional argument.
Parameters
Section titled “Parameters”TKind
The positional argument.
Returns
Section titled “Returns”Positional<TKind, TRequired, TList>
Properties
Section titled “Properties”$default
Section titled “$default”$default:
TypeOf<TKind> |undefined
Defined in: packages/input/dist/index.d.mts:180
The default value of this argument.
$description
Section titled “$description”$description:
string|undefined
Defined in: packages/input/dist/index.d.mts:184
The description of this argument.
$kind:
TKind
Defined in: packages/input/dist/index.d.mts:176
The type of this argument.
$list:
TList
Defined in: packages/input/dist/index.d.mts:192
If this argument is a list.
$required
Section titled “$required”$required:
TRequired
Defined in: packages/input/dist/index.d.mts:188
If this argument is required.
Methods
Section titled “Methods”default()
Section titled “default()”default(
value):this
Defined in: packages/input/dist/index.d.mts:218
Sets a default value.
Parameters
Section titled “Parameters”TypeOf<TKind>
The default value.
Returns
Section titled “Returns”this
this
description()
Section titled “description()”description(
desc):this
Defined in: packages/input/dist/index.d.mts:224
Sets a description.
Parameters
Section titled “Parameters”string
The description.
Returns
Section titled “Returns”this
this
list()
Section titled “list()”list():
Positional<TKind,TRequired,true>
Defined in: packages/input/dist/index.d.mts:202
Makes this argument a list.
Returns
Section titled “Returns”Positional<TKind, TRequired, true>
this
optional()
Section titled “optional()”optional():
Positional<TKind,false,TList>
Defined in: packages/input/dist/index.d.mts:212
Makes this argument optional.
Returns
Section titled “Returns”Positional<TKind, false, TList>
this
required()
Section titled “required()”required():
Positional<TKind,true,TList>
Defined in: packages/input/dist/index.d.mts:207
Makes this argument required.
Returns
Section titled “Returns”Positional<TKind, true, TList>
this