RoadmapShopEvents
Skip to main content

Home > @rushstack/heft > HeftCommandLine

HeftCommandLine class​

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.

Command line utilities provided for Heft plugin developers.

Signature:

export declare class HeftCommandLine

Remarks​

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HeftCommandLine class.

Methods​

MethodModifiersDescription
registerChoiceListParameter(options)(BETA) Utility method used by Heft plugins to register a choiceList type parameter.
registerChoiceParameter(options)(BETA) Utility method used by Heft plugins to register a choice type parameter.
registerFlagParameter(options)(BETA) Utility method used by Heft plugins to register a flag type parameter.
registerIntegerParameter(options)(BETA) Utility method used by Heft plugins to register an integer type parameter.
registerStringListParameter(options)(BETA) Utility method used by Heft plugins to register a stringList type parameter.
registerStringParameter(options)(BETA) Utility method used by Heft plugins to register a string type parameter.