Optional
longFlag: stringThe long-form flag for this option.
--path, --create
Optional
shortFlag: stringThe short-form flag for this option.
-p, -c
Optional
message: stringUsage message describing this flag.
Optional
argumentDescription: stringDescription of the argument required by this flag. If this is set, the flag will expect a positional argument to follow as a param.
Optional
Readonly
argumentDescription of the argument required by this flag. If this is set, the flag will expect a positional argument to follow as a param.
Private
blacklistBlacklisted values.
Optional
Private
equalityThe value to be used to check equality.
Private
greaterIf true, the greater than will be greater than or equal to.
Optional
Private
greaterValue to be compared in greater than.
Private
isIs this option optional?
Private
lessIf true, the less than will be less than or equal to.
Optional
Private
lessValue to be compared in less than.
Optional
Readonly
longThe long-form flag for this option.
--path, --create
Optional
Readonly
messageUsage message describing this flag.
Optional
Readonly
shortThe short-form flag for this option.
-p, -c
Private
useDo we use the blacklist?
Private
useDo we use the equality operator?
Private
useDo we use the greater-than comparison?
Private
useDo we use the less-than comparison?
Private
useDo we use the whitelist?
Private
whitelistWhitelisted values.
Blacklist the specified item or items and enable the blacklist.
Rest
...items: T[]the items to blacklist
Specifies the value to be used in equality comparison and enables that comparison.
Specifies the value to be used in greater-than comparison and enables that comparison.
Specifies the value to be used in greater-than or equal-to comparison and enables that comparison.
Specifies the value to be used in less-than comparison and enables less-than comparison.
Specifies the value to be used in less-than or equal-to comparison and enables that comparison.
Sets the Option as optional.
Whitelist the specified item or items and enable the whitelist.
Rest
...items: T[]the items to whitelist
Non-positional, flag-based CLI option.