ParseArgsOptionDescriptor interface
Properties
| default | The value to assign to
the option if it does not appear in the arguments to be parsed. The value
must match the type specified by the |
| multiple | Whether this option can be provided multiple times.
If |
| short | A single character alias for the option. |
| type | Type of argument. |
Property Details
default
The value to assign to
the option if it does not appear in the arguments to be parsed. The value
must match the type specified by the type property. If multiple is
true, it must be an array. No default value is applied when the option
does appear in the arguments to be parsed, even if the provided value
is falsy.
default?: string | boolean | string[] | boolean[]
Property Value
string | boolean | string[] | boolean[]
multiple
Whether this option can be provided multiple times.
If true, all values will be collected in an array.
If false, values for the option are last-wins.
multiple?: boolean
Property Value
boolean
short
A single character alias for the option.
short?: string
Property Value
string