Skip to main content

Home > @rushstack/heft > IHeftBaseParameter

IHeftBaseParameter interface

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.

The base set of utility values provided in every object returned when registering a parameter.

Signature:
export interface IHeftBaseParameter<TValue, TCommandLineDefinition extends IBaseCommandLineDefinition> 

Properties

PropertyTypeDescription
actionAssociatedboolean(BETA) If true, then the user has invoked Heft with a command line action that supports this parameter (as defined by the IParameterAssociatedActionNames.associatedActionNames option).
definitionIHeftRegisterParameterOptions <TCommandLineDefinition>(BETA) The options IHeftRegisterParameterOptions used to create and register the parameter with a Heft command line action.
value?TValue(BETA) (Optional) The value specified on the command line for this parameter.