RoadmapShopEvents
Skip to main content

Home > @rushstack/heft > HeftSession

HeftSession class

Signature:

export declare class HeftSession 

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 HeftSession class.

Properties

PropertyModifiersTypeDescription
commandLinereadonlyHeftCommandLine(BETA) Command line utilities provided for Heft plugin developers.
debugModereadonlybooleanIf set to true, the build is running with the --debug flag
hooksreadonlyIHeftSessionHooks
registerActionreadonlyRegisterAction(BETA)
requestAccessToPluginByNamereadonlyRequestAccessToPluginByNameCallback(BETA) Call this function to receive a callback with the plugin if and after the specified plugin has been applied. This is used to tap hooks on another plugin.

Methods

MethodModifiersDescription
requestScopedLogger(loggerName)Call this function to request a logger with the specified name.