RoadmapShopEvents
Skip to main content

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

CommandLineChoiceParameter class

The data type returned by CommandLineParameterProvider.defineChoiceParameter() .

Signature:
export declare class CommandLineChoiceParameter extends CommandLineParameter
Extends: [CommandLineParameter](/pages/ts-command-line.commandlineparameter)

Remarks

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

Properties

PropertyModifiersTypeDescription
alternativesReadonlyArray<string>A list of strings (which contain no spaces), of possible options which can be selected
completions(() => Promise<string[]>) | undefinedAn optional callback that provides a list of custom choices for tab completion.
defaultValuestring | undefinedThe default value which will be used if the parameter is omitted from the command line.
kindCommandLineParameterKindIndicates the type of parameter.
valuestring | undefinedReturns the argument value for a choice parameter that was parsed from the command line.

Methods

MethodModifiersDescription
appendToArgList(argList)Append the parsed values to the provided string array.