Class: MassargHelpFlag

option.MassargHelpFlag

A flag that can be passed to a command to show the help message.

Hierarchy

• MassargFlag

  ↳ MassargHelpFlag

Constructors

constructor

• new MassargHelpFlag(config?): MassargHelpFlag

Parameters

Name	Type
config	Partial<Omit<{ name: string ; description: string ; aliases: string[] ; defaultValue?: any ; parse?: Parser<ArgsObject, boolean> ; array?: boolean ; required?: boolean ; isDefault?: boolean ; hidden?: boolean ; outputName?: string }, "parse">>

Returns

MassargHelpFlag

Overrides

MassargFlag.constructor

Defined in

src/option.ts:427

Properties

negatable

• negatable: boolean

Whether this flag may be negated using negationName or negationAliases.

Inherited from

MassargFlag.negatable

Defined in

src/option.ts:359

---

negationName

• negationName: string

The negation name of this flag, which can be used with the full option notation.

Inherited from

MassargFlag.negationName

Defined in

src/option.ts:361

---

negationAliases

• negationAliases: string[]

The negation aliases of this flag, which can be used with the shorthand option notation.

Inherited from

MassargFlag.negationAliases

Defined in

src/option.ts:363

---

name

• name: string

Inherited from

MassargFlag.name

Defined in

src/option.ts:175

---

description

• description: string

Inherited from

MassargFlag.description

Defined in

src/option.ts:176

---

defaultValue

• Optional defaultValue: boolean

Inherited from

MassargFlag.defaultValue

Defined in

src/option.ts:177

---

aliases

• aliases: string[]

Inherited from

MassargFlag.aliases

Defined in

src/option.ts:178

---

parse

• parse: Parser<ArgsObject, boolean>

Inherited from

MassargFlag.parse

Defined in

src/option.ts:179

---

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

MassargFlag.isArray

Defined in

src/option.ts:184

---

isRequired

• isRequired: boolean

Whether this option is required. Failing to specify this option will throw an error.

Inherited from

MassargFlag.isRequired

Defined in

src/option.ts:186

---

isDefault

• isDefault: boolean

Inherited from

MassargFlag.isDefault

Defined in

src/option.ts:187

---

outputName

• Optional outputName: string

Inherited from

MassargFlag.outputName

Defined in

src/option.ts:188

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

MassargOption<T, ArgsObject>

Inherited from

MassargFlag.fromTypedConfig

Defined in

src/option.ts:207

---

parseDetails

▸ parseDetails(argv, _options, prefixes): ArgvValue<boolean>

Parameters

Name	Type
argv	string[]
_options	ArgsObject
prefixes	Prefixes

Returns

ArgvValue<boolean>

Inherited from

MassargFlag.parseDetails

Defined in

src/option.ts:375

---

qualifiedNames

▸ qualifiedNames(prefixes): QualifiedNames

Return the finalized names that will cause this option to match.

Parameters

Name	Type
prefixes	Prefixes

Returns

QualifiedNames

Inherited from

MassargFlag.qualifiedNames

Defined in

src/option.ts:416

---

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

MassargFlag.getOutputName

Defined in

src/option.ts:224

---

helpString

▸ helpString(): string

Get the help string for this option

Returns

string

Inherited from

MassargFlag.helpString

Defined in

src/option.ts:258

---

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

MassargFlag.isMatch

Defined in

src/option.ts:264