RoadmapShopEvents
Skip to main content

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 CommandLineParameter
Extends: [CommandLineParameter](/pages/ts-command-line.commandlineparameter)

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

PropertyModifiersTypeDescription
argumentNamestringThe name of the argument, which will be shown in the command-line help.
completions(() => Promise<string[]>) | undefinedAn optional callback that provides a list of custom choices for tab completion.