interface Option

Interface for SubCommand option arguments.

Properties

readonly
optional
shortAlias: string

Optional short alias for the option.

Must consist of a single alphanumeric non-whitespace ASCII character.

readonly
optional
defaultValue: ArgumentValueType

Default value for the argument if not specified.

readonly
optional
isOptional: boolean

If this is true the option does not need to be specified nor have a default value.

readonly
optional
isArray: boolean

If this is true the option can be specified multiple times and all values will be returned in an array matching the order provided.

NOTE: If isOptional is false, at least one instance of the option must be specified.

Usage

import type Option from ".";