Skip to content

workflow / Exports / WorkflowQuery

Interface: WorkflowQuery

Workflow query interface for advanced querying

Implemented by

Table of contents

Methods

Methods

findNodes

findNodes(criteria): WorkflowNode[]

Find nodes by criteria

Parameters

NameType
criteriaObject
criteria.type?string | string[]
criteria.status?string | string[]
criteria.level?number | number[]
criteria.parentId?string
criteria.hasChildren?boolean

Returns

WorkflowNode[]

Defined in

interfaces/workflow-builder.ts:181


findEdges

findEdges(criteria): WorkflowEdge[]

Find edges by criteria

Parameters

NameType
criteriaObject
criteria.type?string | string[]
criteria.sourceId?string
criteria.targetId?string
criteria.hidden?boolean

Returns

WorkflowEdge[]

Defined in

interfaces/workflow-builder.ts:193


getConnectedNodes

getConnectedNodes(nodeId, direction?): WorkflowNode[]

Get connected nodes

Parameters

NameType
nodeIdstring
direction?"incoming" | "outgoing" | "both"

Returns

WorkflowNode[]

Defined in

interfaces/workflow-builder.ts:204


getNodePath

getNodePath(nodeId): WorkflowNode[]

Get node path from root

Parameters

NameType
nodeIdstring

Returns

WorkflowNode[]

Defined in

interfaces/workflow-builder.ts:209


getDepth

getDepth(): number

Get workflow depth

Returns

number

Defined in

interfaces/workflow-builder.ts:214


getDisconnectedComponents

getDisconnectedComponents(): WorkflowNode[][]

Find disconnected components

Returns

WorkflowNode[][]

Defined in

interfaces/workflow-builder.ts:219

Released under the MIT License.