Class: MassargNumber
option.MassargNumber
An option that can be passed to a command.
This type of option parses a number, and fails if it is not a valid number.
Example
massarg(options).option({
name: 'number',
description: 'A number',
defaultValue: 0,
aliases: ['n'],
type: 'number',
})
Hierarchy
-
MassargOption<number>↳
MassargNumber
Constructors
constructor
• new MassargNumber(options): MassargNumber
Parameters
| Name | Type |
|---|---|
options | Omit<{ name: string ; description: string ; aliases: string[] ; defaultValue?: any ; parse?: Parser<ArgsObject, number> ; array?: boolean ; required?: boolean ; isDefault?: boolean ; hidden?: boolean ; outputName?: string }, "parse"> |
Returns
Overrides
Defined in
Properties
name
• name: string
Inherited from
Defined in
description
• description: string
Inherited from
Defined in
defaultValue
• Optional defaultValue: number
Inherited from
Defined in
aliases
• aliases: string[]
Inherited from
Defined in
parse
• parse: Parser<ArgsObject, number>
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 | Description |
|---|---|---|
config | Object | - |
config.name | string | Name of the option |
config.description | string | Description of the option, displayed in the help output |
config.aliases | string[] | Aliases for the option, which can be used with the shorthand option notation. |
config.defaultValue? | any | Default value of the option |
config.parse? | Parser<A, T> | Parse the value of the option. You can return any type here, or throw an error if the value is invalid. |
config.array? | boolean | Whether the option is an array. Array options can be specified multiple times, and the values will be collected into an array. Normally, specifying an option multiple times will override the previous value. |
config.required? | boolean | Whether the option is required. If it is required, parsing will throw an error if it's not present. |
config.isDefault? | boolean | Whether the option is the default option. The default option is the option that is used if no other option is specified, e.g. a value is passed in without an option name. Note that if commands match the same argument first, they will be used instead of the default option. |
config.hidden? | boolean | Whether the option is hidden. Hidden options are not displayed in the help output. |
config.outputName? | string | Specify a custom name for the output, which will be used when parsing the args. |
config.type? | "number" | - |
Returns
Inherited from
Defined in
parseDetails
▸ parseDetails(argv, options, prefixes): ArgvValue<number>
Parameters
| Name | Type |
|---|---|
argv | string[] |
options | ArgsObject |
prefixes | Prefixes |
Returns
ArgvValue<number>
Overrides
MassargOption.parseDetails
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
Inherited from
Defined in
qualifiedNames
▸ qualifiedNames(prefixes): QualifiedNames
Return the finalized names that will cause this option to match.
Parameters
| Name | Type |
|---|---|
prefixes | Prefixes |