Home > @rushstack/ts-command-line > CommandLineParameterWithArgument

CommandLineParameterWithArgument class

The common base class for parameters types that receive an argument.

Signature:

export declare abstract class CommandLineParameterWithArgument extends CommandLineParameterBase 

Extends: CommandLineParameterBase

Remarks

An argument is an accompanying command-line token, such as "123" in the example "--max-count 123".

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CommandLineParameterWithArgument class.

Properties

Property	Modifiers	Type	Description
argumentName	readonly	string	The name of the argument, which will be shown in the command-line help.
getCompletionsAsync	readonly	(() => Promise<ReadonlyArray<string> | ReadonlySet<string>>) | undefined	An optional callback that provides a list of custom choices for tab completion.