Home > @rushstack/heft > IHeftLifecycleHooks
IHeftLifecycleHooks interface
Hooks that are available to the lifecycle plugin.
Signature:
export interface IHeftLifecycleHooks
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| clean | AsyncParallelHook<IHeftLifecycleCleanHookOptions> | The clean hook is called at the beginning of Heft execution. It can be used to clean up any files or folders that may be produced by the plugin. To use it, call clean.tapPromise(<pluginName>, <callback>). | |
| recordMetrics | AsyncParallelHook<IHeftRecordMetricsHookOptions> | ||
| toolFinish | AsyncParallelHook<IHeftLifecycleToolFinishHookOptions> | The toolFinish hook is called at the end of Heft execution. It is called after all phases have completed execution. To use it, call toolFinish.tapPromise(<pluginName>, <callback>). | |
| toolStart | AsyncParallelHook<IHeftLifecycleToolStartHookOptions> | The toolStart hook is called at the beginning of Heft execution, after the clean hook. It is called before any phases have begun to execute. To use it, call toolStart.tapPromise(<pluginName>, <callback>). |