Skip to main content

Home > @rushstack/heft > HeftCommandLine > registerChoiceParameter

HeftCommandLine.registerChoiceParameter() method

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Utility method used by Heft plugins to register a choice type parameter.

Signature:
registerChoiceParameter(options: IHeftRegisterParameterOptions<ICommandLineChoiceDefinition>): IHeftChoiceParameter;

Parameters

ParameterTypeDescription
optionsIHeftRegisterParameterOptions <ICommandLineChoiceDefinition >
Returns:

IHeftChoiceParameter