Rush StackShopBlogEvents
Skip to main content

Home > @microsoft/rush-lib > IGlobalCommand > getCustomParametersByLongName

IGlobalCommand.getCustomParametersByLongName() method

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

Get a parameter by its long name (e.g. "--output-path") that was defined in command-line.json for this command. If the parameter was not defined or not provided on the command line, this will throw.

Signature:

getCustomParametersByLongName<TParameter extends CommandLineParameter>(longName: string): TParameter;

Parameters

Parameter

Type

Description

longName

string

Returns:

TParameter