Skip to main content

PluginHooks

Nadle / PluginHooks

Interface: PluginHooks<Options>

Defined in: packages/nadle/src/core/plugins/plugin.ts:65

Optional plugin lifecycle hooks. All run on the main thread.

Type Parameters​

Options​

Options

Properties​

afterAll?​

readonly optional afterAll?: (ctx) => Awaitable<void>

Defined in: packages/nadle/src/core/plugins/plugin.ts:67

Runs once after the run settles (success or failure).

Parameters​

ctx​

RunHookContext<Options>

Returns​

Awaitable<void>

afterTask?​

readonly optional afterTask?: (ctx) => Awaitable<void>

Defined in: packages/nadle/src/core/plugins/plugin.ts:71

Runs after a task settles, for every outcome (see ctx.result).

Parameters​

ctx​

TaskHookContext<Options>

Returns​

Awaitable<void>

beforeAll?​

readonly optional beforeAll?: (ctx) => Awaitable<void>

Defined in: packages/nadle/src/core/plugins/plugin.ts:69

Runs once before scheduling. Throwing aborts the run.

Parameters​

ctx​

RunHookContext<Options>

Returns​

Awaitable<void>

beforeTask?​

readonly optional beforeTask?: (ctx) => Awaitable<void>

Defined in: packages/nadle/src/core/plugins/plugin.ts:73

Runs before a task actually executes (not fired for cache hits).

Parameters​

ctx​

TaskHookContext<Options>

Returns​

Awaitable<void>