Skip to content

workflow / Exports / ExtendedWorkflowBuilder

Interface: ExtendedWorkflowBuilder

Extended workflow builder with management capabilities

Hierarchy

Implemented by

Table of contents

Methods

Methods

getSnapshot

getSnapshot(): WorkflowSnapshot

Get current workflow snapshot

Returns

WorkflowSnapshot

Inherited from

WorkflowBuilder.getSnapshot

Defined in

interfaces/workflow-builder.ts:58


getAllNodes

getAllNodes(): WorkflowNode[]

Get all nodes

Returns

WorkflowNode[]

Inherited from

WorkflowBuilder.getAllNodes

Defined in

interfaces/workflow-builder.ts:63


getAllEdges

getAllEdges(): WorkflowEdge[]

Get all edges

Returns

WorkflowEdge[]

Inherited from

WorkflowBuilder.getAllEdges

Defined in

interfaces/workflow-builder.ts:68


getNode

getNode(nodeId): undefined | WorkflowNode

Get node by ID

Parameters

NameType
nodeIdstring

Returns

undefined | WorkflowNode

Inherited from

WorkflowBuilder.getNode

Defined in

interfaces/workflow-builder.ts:73


getEdge

getEdge(edgeId): undefined | WorkflowEdge

Get edge by ID

Parameters

NameType
edgeIdstring

Returns

undefined | WorkflowEdge

Inherited from

WorkflowBuilder.getEdge

Defined in

interfaces/workflow-builder.ts:78


hasNode

hasNode(nodeId): boolean

Check if node exists

Parameters

NameType
nodeIdstring

Returns

boolean

Inherited from

WorkflowBuilder.hasNode

Defined in

interfaces/workflow-builder.ts:83


hasEdge

hasEdge(edgeId): boolean

Check if edge exists

Parameters

NameType
edgeIdstring

Returns

boolean

Inherited from

WorkflowBuilder.hasEdge

Defined in

interfaces/workflow-builder.ts:88


subscribe

subscribe(callback): () => void

Subscribe to workflow updates

Parameters

NameType
callbackWorkflowUpdateCallback

Returns

fn

▸ (): void

Returns

void

Inherited from

WorkflowBuilder.subscribe

Defined in

interfaces/workflow-builder.ts:93


unsubscribe

unsubscribe(callback): void

Unsubscribe from workflow updates

Parameters

NameType
callbackWorkflowUpdateCallback

Returns

void

Inherited from

WorkflowBuilder.unsubscribe

Defined in

interfaces/workflow-builder.ts:98


clear

clear(): void

Clear all data

Returns

void

Inherited from

WorkflowBuilder.clear

Defined in

interfaces/workflow-builder.ts:103


getStats

getStats(): Object

Get workflow statistics

Returns

Object

NameType
nodeCountnumber
edgeCountnumber
totalUpdatesnumber
lastUpdateTime?Date

Inherited from

WorkflowBuilder.getStats

Defined in

interfaces/workflow-builder.ts:108


addNode

addNode(node, parentNodeId?): WorkflowNode

Add node to workflow

Parameters

NameType
nodeOmit<WorkflowNode, "timestamp">
parentNodeId?string

Returns

WorkflowNode

Defined in

interfaces/workflow-builder.ts:123


updateNode

updateNode(nodeId, updates): null | WorkflowNode

Update existing node

Parameters

NameType
nodeIdstring
updatesPartial<WorkflowNode>

Returns

null | WorkflowNode

Defined in

interfaces/workflow-builder.ts:128


removeNode

removeNode(nodeId): boolean

Remove node from workflow

Parameters

NameType
nodeIdstring

Returns

boolean

Defined in

interfaces/workflow-builder.ts:133


addEdge

addEdge(edge): WorkflowEdge

Add edge to workflow

Parameters

NameType
edgeOmit<WorkflowEdge, "timestamp">

Returns

WorkflowEdge

Defined in

interfaces/workflow-builder.ts:138


updateEdge

updateEdge(edgeId, updates): null | WorkflowEdge

Update existing edge

Parameters

NameType
edgeIdstring
updatesPartial<WorkflowEdge>

Returns

null | WorkflowEdge

Defined in

interfaces/workflow-builder.ts:143


removeEdge

removeEdge(edgeId): boolean

Remove edge from workflow

Parameters

NameType
edgeIdstring

Returns

boolean

Defined in

interfaces/workflow-builder.ts:148


batch

batch(operations): void

Batch operations for performance

Parameters

NameType
operations{ type: "addNode" | "updateNode" | "removeNode" | "addEdge" | "updateEdge" | "removeEdge" ; data: unknown }[]

Returns

void

Defined in

interfaces/workflow-builder.ts:153


validate

validate(): Object

Validate current workflow state

Returns

Object

NameType
isValidboolean
errorsstring[]
warningsstring[]

Defined in

interfaces/workflow-builder.ts:161


getRawNodes

getRawNodes(): WorkflowNode[]

Raw accessors (append-only order) for source-of-truth export without any transformation

Returns

WorkflowNode[]

Defined in

interfaces/workflow-builder.ts:170


getRawEdges

getRawEdges(): WorkflowEdge[]

Returns

WorkflowEdge[]

Defined in

interfaces/workflow-builder.ts:171

Released under the MIT License.