Workflow
Defined in: src/Workflow.ts:81
Constructors
Constructor
new Workflow(config): Workflow;Defined in: src/Workflow.ts:92
Parameters
config
Returns
Workflow
Properties
id
readonly id: string;Defined in: src/Workflow.ts:82
links
links: Map<string, Link>;Defined in: src/Workflow.ts:88
name
name: string;Defined in: src/Workflow.ts:83
networkDefs
networkDefs: NetworkDef[];Defined in: src/Workflow.ts:85
networks
networks: string[];Defined in: src/Workflow.ts:84
nodes
nodes: Map<string, Node>;Defined in: src/Workflow.ts:87
services
services: ServiceDef[];Defined in: src/Workflow.ts:86
Methods
addLink()
addLink(config): Link;Defined in: src/Workflow.ts:124
Validates nodes exist, no self-loop, valid when, cycles require maxIterations
Parameters
config
Returns
addLinks()
addLinks(links): Link[];Defined in: src/Workflow.ts:208
Parameters
links
Returns
Link[]
addNode()
addNode(config): Node;Defined in: src/Workflow.ts:114
Inherits workflow networks if the node declares none
Parameters
config
Returns
execute()
execute(initialData?, options?): Promise<ExecutionResult>;Defined in: src/Workflow.ts:261
Parameters
initialData?
Record<string, unknown> = {}
options?
ExecuteOptions = {}
Returns
Promise<ExecutionResult>
findLink()
findLink(from, to): Link | undefined;Defined in: src/Workflow.ts:234
Parameters
from
string
to
string
Returns
Link | undefined
getEntryNodes()
getEntryNodes(): Node[];Defined in: src/Workflow.ts:217
Nodes with no incoming forward links (back-links excluded)
Returns
Node[]
getIncomingLinks()
getIncomingLinks(nodeId): Link[];Defined in: src/Workflow.ts:230
Parameters
nodeId
string
Returns
Link[]
getNode()
getNode(id): Node | undefined;Defined in: src/Workflow.ts:212
Parameters
id
string
Returns
Node | undefined
getOutgoingLinks()
getOutgoingLinks(nodeId): Link[];Defined in: src/Workflow.ts:226
Parameters
nodeId
string
Returns
Link[]
removeLink()
removeLink(from, to): boolean;Defined in: src/Workflow.ts:239
Parameters
from
string
to
string
Returns
boolean
toJSON()
toJSON(): WorkflowJSON;Defined in: src/Workflow.ts:265
Returns
fromJSON()
static fromJSON(json): Workflow;Defined in: src/Workflow.ts:277
Parameters
json
Returns
Workflow