Skip to content

workflow / Exports / WorkflowBuilder

Interface: WorkflowBuilder

Core workflow builder interface

Hierarchy

Table of contents

Methods

Methods

getSnapshot

getSnapshot(): WorkflowSnapshot

Get current workflow snapshot

Returns

WorkflowSnapshot

Defined in

interfaces/workflow-builder.ts:58


getAllNodes

getAllNodes(): WorkflowNode[]

Get all nodes

Returns

WorkflowNode[]

Defined in

interfaces/workflow-builder.ts:63


getAllEdges

getAllEdges(): WorkflowEdge[]

Get all edges

Returns

WorkflowEdge[]

Defined in

interfaces/workflow-builder.ts:68


getNode

getNode(nodeId): undefined | WorkflowNode

Get node by ID

Parameters

NameType
nodeIdstring

Returns

undefined | WorkflowNode

Defined in

interfaces/workflow-builder.ts:73


getEdge

getEdge(edgeId): undefined | WorkflowEdge

Get edge by ID

Parameters

NameType
edgeIdstring

Returns

undefined | WorkflowEdge

Defined in

interfaces/workflow-builder.ts:78


hasNode

hasNode(nodeId): boolean

Check if node exists

Parameters

NameType
nodeIdstring

Returns

boolean

Defined in

interfaces/workflow-builder.ts:83


hasEdge

hasEdge(edgeId): boolean

Check if edge exists

Parameters

NameType
edgeIdstring

Returns

boolean

Defined in

interfaces/workflow-builder.ts:88


subscribe

subscribe(callback): () => void

Subscribe to workflow updates

Parameters

NameType
callbackWorkflowUpdateCallback

Returns

fn

▸ (): void

Returns

void

Defined in

interfaces/workflow-builder.ts:93


unsubscribe

unsubscribe(callback): void

Unsubscribe from workflow updates

Parameters

NameType
callbackWorkflowUpdateCallback

Returns

void

Defined in

interfaces/workflow-builder.ts:98


clear

clear(): void

Clear all data

Returns

void

Defined in

interfaces/workflow-builder.ts:103


getStats

getStats(): Object

Get workflow statistics

Returns

Object

NameType
nodeCountnumber
edgeCountnumber
totalUpdatesnumber
lastUpdateTime?Date

Defined in

interfaces/workflow-builder.ts:108

Released under the MIT License.