Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/heft > IHeftParameters

IHeftParameters interface

Parameters provided to a Heft plugin.

Signature:

export interface IHeftParameters extends IHeftDefaultParameters 

Extends: IHeftDefaultParameters

Methods

MethodDescription
getChoiceListParameter(parameterLongName)Get a choice list parameter that has been defined in heft-plugin.json.
getChoiceParameter(parameterLongName)Get a choice parameter that has been defined in heft-plugin.json.
getFlagParameter(parameterLongName)Get a flag parameter that has been defined in heft-plugin.json.
getIntegerListParameter(parameterLongName)Get an integer list parameter that has been defined in heft-plugin.json.
getIntegerParameter(parameterLongName)Get an integer parameter that has been defined in heft-plugin.json.
getStringListParameter(parameterLongName)Get a string list parameter that has been defined in heft-plugin.json.
getStringParameter(parameterLongName)Get a string parameter that has been defined in heft-plugin.json.