Skip to main content

Interface: PluginDefinition<T>

Defined in: packages/workflow-engine/src/kernel/plugins.ts:16

Type Parameters​

T​

T extends KernelEventType = KernelEventType

Properties​

id​

readonly id: string

Defined in: packages/workflow-engine/src/kernel/plugins.ts:17


name​

readonly name: string

Defined in: packages/workflow-engine/src/kernel/plugins.ts:18


on​

readonly on: readonly T[]

Defined in: packages/workflow-engine/src/kernel/plugins.ts:19

Methods​

handle()​

handle(event): Promise<void>

Defined in: packages/workflow-engine/src/kernel/plugins.ts:20

Parameters​

event​

Extract<WorkflowCreatedEvent, { type: T; }> | Extract<WorkflowStartedEvent, { type: T; }> | Extract<WorkflowCompletedEvent, { type: T; }> | Extract<WorkflowFailedEvent, { type: T; }> | Extract<WorkflowCancelledEvent, { type: T; }> | Extract<WorkflowSuspendedEvent, { type: T; }> | Extract<StageStartedEvent, { type: T; }> | Extract<StageCompletedEvent, { type: T; }> | Extract<StageSuspendedEvent, { type: T; }> | Extract<StageFailedEvent, { type: T; }> | Extract<StageRetryingEvent, { type: T; }> | Extract<StageProgressEvent, { type: T; }> | Extract<StepSignalledEvent, { type: T; }> | Extract<AnnotationCreatedEvent, { type: T; }>

Returns​

Promise<void>