RoadmapShopEvents
Skip to main content

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

PropertyModifiersTypeDescription
initializeAsyncSeriesHook<IRushCommand >(BETA) The hook to run before executing any Rush CLI Command.
runAnyGlobalCustomCommandAsyncSeriesHook<IGlobalCommand >(BETA) The hook to run before executing any global Rush CLI Command (defined in command-line.json).
runAnyPhasedCommandAsyncSeriesHook<IPhasedCommand >(BETA) The hook to run before executing any phased Rush CLI Command (defined in command-line.json, or the default "build" or "rebuild").
runGlobalCustomCommandHookMap<AsyncSeriesHook<IGlobalCommand >>(BETA) A hook map to allow plugins to hook specific named global commands (defined in command-line.json) before execution.
runPhasedCommandHookMap<AsyncSeriesHook<IPhasedCommand >>(BETA) A hook map to allow plugins to hook specific named phased commands (defined in command-line.json) before execution.