Home > @microsoft/rush-lib > RushLifecycleHooks
RushLifecycleHooks 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.
Hooks into the lifecycle of the Rush process invocation that plugins may tap into.
Signature:
export declare class RushLifecycleHooks
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| beforeInstall | AsyncSeriesHook<IGlobalCommand> | (BETA) The hook to run between preparing the common/temp folder and invoking the package manager during "rush install" or "rush update". | |
| flushTelemetry | AsyncParallelHook<[ReadonlyArray<ITelemetryData>]> | (BETA) A hook to allow plugins to hook custom logic to process telemetry data. | |
| initialize | AsyncSeriesHook<IRushCommand> | (BETA) The hook to run before executing any Rush CLI Command. | |
| runAnyGlobalCustomCommand | AsyncSeriesHook<IGlobalCommand> | (BETA) The hook to run before executing any global Rush CLI Command (defined in command-line.json). | |
| runAnyPhasedCommand | AsyncSeriesHook<IPhasedCommand> | (BETA) The hook to run before executing any phased Rush CLI Command (defined in command-line.json, or the default "build" or "rebuild"). | |
| runGlobalCustomCommand | HookMap<AsyncSeriesHook<IGlobalCommand>> | (BETA) A hook map to allow plugins to hook specific named global commands (defined in command-line.json) before execution. | |
| runPhasedCommand | HookMap<AsyncSeriesHook<IPhasedCommand>> | (BETA) A hook map to allow plugins to hook specific named phased commands (defined in command-line.json) before execution. |