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

ICommandLineChoiceListDefinition interface

For use with CommandLineParameterProvider.defineChoiceListParameter(), this interface defines a command line parameter which is constrained to a list of possible options. The parameter can be specified multiple times to build a list.

Signature:

export interface ICommandLineChoiceListDefinition extends IBaseCommandLineDefinition 

Extends: IBaseCommandLineDefinition

Properties

Property	Modifiers	Type	Description
alternatives		string[]	A list of strings (which contain no spaces), of possible options which can be selected
completions?		() => Promise<string[]>	(Optional) An optional callback that provides a list of custom choices for tab completion.