Class: MassargFlag
option.MassargFlag
A boolean option that can be passed to a command.
A flag is an option that is either present or not. It can be used to toggle a boolean value, or to indicate that a command should be run in a different mode.
A flag can be negated by using negatable: true. By default, the negated name is the same
as the option name, prefixed by no-, and each of the aliases will be uppercased.
For example, --verbose and --no-verbose, or -v and -V.
This behavior can be overridden by the negatedName and negatedAliases options.
Example
massarg.flag({
name: 'verbose',
aliases: ['v'],
description: 'Enable verbose logging',
defaultValue: false,
})
Hierarchy
-
MassargOption<boolean>↳
MassargFlag
Constructors
constructor
• new MassargFlag(options): MassargFlag
Parameters
| Name | Type |
|---|---|
options | Object |
options.name | string |
options.description | string |
options.aliases | string[] |
options.defaultValue | any |
options.array | undefined | boolean |
options.required | undefined | boolean |
options.hidden | undefined | boolean |
options.outputName | undefined | string |
options.negatable | undefined | boolean |
options.negationName | undefined | string |
options.negationAliases | undefined | string[] |
Returns
Overrides
Defined in
Properties
negatable
• negatable: boolean
Whether this flag may be negated using negationName or negationAliases.
Defined in
negationName
• negationName: string
The negation name of this flag, which can be used with the full option notation.
Defined in
negationAliases
• negationAliases: string[]
The negation aliases of this flag, which can be used with the shorthand option notation.
Defined in
name
• name: string
Inherited from
Defined in
description
• description: string
Inherited from
Defined in
defaultValue
• Optional defaultValue: boolean
Inherited from
Defined in
aliases
• aliases: string[]
Inherited from
Defined in
parse
• parse: Parser<ArgsObject, boolean>
Inherited from
Defined in
isArray
• isArray: boolean
Whether this option can be used multiple times. Any passed values will end up in an array instead of each usage overwriting the existing value.
Inherited from
Defined in
isRequired
• isRequired: boolean
Whether this option is required. Failing to specify this option will throw an error.
Inherited from
Defined in
isDefault
• isDefault: boolean
Inherited from
Defined in
outputName
• Optional outputName: string
Inherited from
Defined in
Methods
fromTypedConfig
▸ fromTypedConfig<T, A>(config): MassargOption<T, ArgsObject>
Create a typed option from a configuration. Currently supports number options which
are automatically transformed from string to number.
Type parameters
| Name | Type |
|---|---|
T | unknown |
A | extends ArgsObject = ArgsObject |
Parameters
| Name | Type |
|---|---|
config | Object |
config.name | string |
config.description | string |
config.aliases | string[] |
config.type | undefined | "number" |
config.defaultValue | any |
config.array | undefined | boolean |
config.required | undefined | boolean |
config.isDefault | undefined | boolean |
config.hidden | undefined | boolean |
config.outputName | undefined | string |
config.parse | undefined | Parser<A, T> |
Returns
Inherited from
Defined in
parseDetails
▸ parseDetails(argv, _options, prefixes): ArgvValue<boolean>
Parameters
| Name | Type |
|---|---|
argv | string[] |
_options | ArgsObject |
prefixes | Prefixes |
Returns
ArgvValue<boolean>
Overrides
MassargOption.parseDetails
Defined in
qualifiedNames
▸ qualifiedNames(prefixes): QualifiedNames
Return the finalized names that will cause this option to match.
Parameters
| Name | Type |
|---|---|
prefixes | Prefixes |
Returns
Overrides
Defined in
getOutputName
▸ getOutputName(): string
Returns the key which this option outputs to in the final object.
Returns
string
Default
The camelCase version of this option's name.
Can be overridden with {@link outputName}.
Inherited from
Defined in
helpString
▸ helpString(): string
Get the help string for this option
Returns
string
Inherited from
Defined in
isMatch
▸ isMatch(arg, prefixes): boolean
Returns true if the flag (including any prefixes) matches the name or aliases
Parameters
| Name | Type |
|---|---|
arg | string |
prefixes | Prefixes |
Returns
boolean