Class FlowBuilder

The flow builder to build a flow.

Index

Constructors

Properties

Methods

addContext addNode addStartNode getFlow setStartElement

Constructors

constructor

new FlowBuilder(flow): FlowBuilder
Construct a flow builder with intial setup. The added node and context will be directly written into the given flow.
Parameters
- flow: FlowInputModel
  the initial flow.
Returns FlowBuilder

Properties

`Protected` `Readonly` flow

flow: FlowInputModel

Methods

addContext

addContext<T>(type, defn): FlowContextMap[T]
Add a context variable definition.
Type Parameters
- T extends keyof FlowContext
Parameters
- type: T
  the type of the context.
- defn: FlowContextMap[T]
  the definition.
Returns FlowContextMap[T]
the definition.

addNode

addNode<T>(type, meta): FlowNodeMetaMap[T]
Add a node to the flow and return.
Type Parameters
- T extends keyof FlowNodes
Parameters
- type: T
  the node type.
- meta: FlowNodeMetaMap[T]
  the metadata of the node.
Returns FlowNodeMetaMap[T]
the metadata.

addStartNode

addStartNode<T>(type, meta): FlowNodeMetaMap[T]
A handy method to add a node to the flow and set as start element.
Type Parameters
- T extends keyof FlowNodes
Parameters
- type: T
  the node type.
- meta: FlowNodeMetaMap[T]
  the metadata of the node.
Returns FlowNodeMetaMap[T]
the metadata.

getFlow

getFlow(): FlowInputModel
Get the underly flow.

Returns FlowInputModel
the underly flow.

setStartElement

setStartElement(name): void
Set the start element.
Parameters
- name: string
  the name of the start element.
Returns void