Skip to content

Interface: Plugin ​

Defined in: index.ts:240

Properties ​

name ​

name: string

Defined in: index.ts:242

Unique name for the plugin.

Methods ​

onAfterNodeExecution()? ​

optional onAfterNodeExecution(context): Promise<void>

Defined in: index.ts:248

Called after a node is executed successfully.

Parameters ​

context ​

PluginContext

Returns ​

Promise<void>


onBeforeNodeExecution()? ​

optional onBeforeNodeExecution(context): Promise<void>

Defined in: index.ts:245

Called before a node is executed.

Parameters ​

context ​

PluginContext

Returns ​

Promise<void>


onNodeError()? ​

optional onNodeError(context): Promise<void>

Defined in: index.ts:251

Called when a node execution fails.

Parameters ​

context ​

ErrorPluginContext

Returns ​

Promise<void>


onWorkflowComplete()? ​

optional onWorkflowComplete(snapshot): Promise<void>

Defined in: index.ts:257

Called when the workflow completes successfully.

Parameters ​

snapshot ​

Snapshot

Returns ​

Promise<void>


onWorkflowPause()? ​

optional onWorkflowPause(snapshot): Promise<void>

Defined in: index.ts:260

Called when the workflow is paused.

Parameters ​

snapshot ​

Snapshot

Returns ​

Promise<void>


onWorkflowStart()? ​

optional onWorkflowStart(snapshot): Promise<void>

Defined in: index.ts:254

Called when the workflow starts.

Parameters ​

snapshot ​

Snapshot

Returns ​

Promise<void>