Skip to content

workflow / Exports / PluginContext

Interface: PluginContext

Plugin context for lifecycle hooks

Table of contents

Properties

Properties

nodes

nodes: Map<string, WorkflowNode>

Defined in

interfaces/workflow-plugin.ts:43


edges

edges: Map<string, WorkflowEdge>

Defined in

interfaces/workflow-plugin.ts:44


createNode

createNode: (nodeData: Omit<WorkflowNode, "timestamp">) => WorkflowNode

Type declaration

▸ (nodeData): WorkflowNode

Parameters
NameType
nodeDataOmit<WorkflowNode, "timestamp">
Returns

WorkflowNode

Defined in

interfaces/workflow-plugin.ts:47


createEdge

createEdge: (edgeData: Omit<WorkflowEdge, "timestamp">) => WorkflowEdge

Type declaration

▸ (edgeData): WorkflowEdge

Parameters
NameType
edgeDataOmit<WorkflowEdge, "timestamp">
Returns

WorkflowEdge

Defined in

interfaces/workflow-plugin.ts:48


updateNode

updateNode: (nodeId: string, updates: Partial<WorkflowNode>) => null | WorkflowNode

Type declaration

▸ (nodeId, updates): null | WorkflowNode

Parameters
NameType
nodeIdstring
updatesPartial<WorkflowNode>
Returns

null | WorkflowNode

Defined in

interfaces/workflow-plugin.ts:49


updateEdge

updateEdge: (edgeId: string, updates: Partial<WorkflowEdge>) => null | WorkflowEdge

Type declaration

▸ (edgeId, updates): null | WorkflowEdge

Parameters
NameType
edgeIdstring
updatesPartial<WorkflowEdge>
Returns

null | WorkflowEdge

Defined in

interfaces/workflow-plugin.ts:50


pluginName

pluginName: string

Defined in

interfaces/workflow-plugin.ts:53


hookName

hookName: PluginLifecycle

Defined in

interfaces/workflow-plugin.ts:54


timestamp

timestamp: Date

Defined in

interfaces/workflow-plugin.ts:55


logger

logger: Object

Type declaration

NameType
debug(message: string, ...args: unknown[]) => void
info(message: string, ...args: unknown[]) => void
warn(message: string, ...args: unknown[]) => void
error(message: string, ...args: unknown[]) => void

Defined in

interfaces/workflow-plugin.ts:58

Released under the MIT License.