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.


Property Modifiers Type Description
alternatives   ReadonlyArray<string> A list of strings (which contain no spaces), of possible options which can be selected
completions   (() => Promise<string[]>) | undefined An optional callback that provides a list of custom choices for tab completion.
defaultValue   string | undefined The default value which will be used if the parameter is omitted from the command line.
kind   CommandLineParameterKind Indicates the type of parameter.
value   string | undefined Returns the argument value for a choice parameter that was parsed from the command line.


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