Rush StackShopBlogEvents
Skip to main content

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

CommandLineChoiceParameter class

The data type returned by CommandLineParameterProvider.defineChoiceParameter().


export declare class CommandLineChoiceParameter extends CommandLineParameter 

Extends: CommandLineParameter


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.


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


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