API for rete-engine package

DataflowEngine

src/dataflow-engine.ts

DataflowEngine is a plugin that integrates Dataflow with NodeEditor making it easy to use. Additionally, it provides a cache for the data of each node in order to avoid recurring calculations.

class DataflowEngine<Schemes extends DataflowEngineScheme>

Extends Scope<never, Root>

Listens nodecreated noderemoved

fetch

src/dataflow-engine.ts

Fetches output data of the node

fetch(nodeId: string): Promise<Record<string, any>>

Throws Cancelled when reset is called while fetching data

Returns Promise<Record<string, any>>

fetchInputs

src/dataflow-engine.ts

Fetches input data for the node by fetching data for all its predecessors recursively.

fetchInputs(nodeId: string): Promise<Record<string, any>>

Throws Cancelled when reset` is called while fetching data

Returns Promise<Record<string, any>>

reset

src/dataflow-engine.ts

Resets the cache of the node and all its predecessors.

reset(nodeId: string): void

Returns void

ControlFlowEngine

src/control-flow-engine.ts

ControlFlowEngine is a plugin that integrates ControlFlow with NodeEditor making it easy to use

class ControlFlowEngine<Schemes extends ControlFlowEngineScheme>

Extends Scope<never, Root>

Listens nodecreated noderemoved

constructor

src/control-flow-engine.ts

constructor(configure: Configure<Schemes>): ControlFlowEngine<Schemes>

Returns ControlFlowEngine<Schemes>

execute

src/control-flow-engine.ts

Trigger execution starting from the specified node.

execute(nodeId: string, input: string): void

Returns void

Dataflow

src/dataflow.ts

Dataflow is a class that allows to process nodes in a graph using Dataflow approach.

class Dataflow<Schemes extends ClassicScheme>

constructor

src/dataflow.ts

constructor(editor: NodeEditor<Schemes>): Dataflow<Schemes>

Returns Dataflow<Schemes>

add

src/dataflow.ts

Adds the node to the dataflow.

add(node: T, setup: DataflowNodeSetup<T, any, any>): void

Returns void

fetch

src/dataflow.ts

Fetches outputs of the node. This method recursively calls data function of the predecessor nodes until receives all of the required inputs and calls data function of the specified node.

fetch(nodeId: string): Promise<Record<string, any>>

Returns Promise<Record<string, any>> Object with outputs

fetchInputs

src/dataflow.ts

Fetches inputs of the node. Unlike fetch method, this method doesn't call data function of the specified node (but does call data for predecessor nodes recursively).

fetchInputs(nodeId: string): Promise<Record<string, any>>

Returns Promise<Record<string, any>> Object with inputs

remove

src/dataflow.ts

Removes the node from the dataflow.

remove(nodeId: string): void

Returns void

ControlFlow

src/control-flow.ts

ControlFlow is a class that allows to execute nodes in a graph using Control flow approach.

class ControlFlow<Schemes extends ClassicScheme>

constructor

src/control-flow.ts

constructor(editor: NodeEditor<Schemes>): ControlFlow<Schemes>

Returns ControlFlow<Schemes>

add

src/control-flow.ts

Adds the node to the control flow.

add(node: T, setup: ControlFlowNodeSetup<T, (keyof T["inputs"])[], (keyof T["outputs"])[]>): void

Returns void

execute

src/control-flow.ts

Execute the node and its successors (in case forward is called for some output).

execute(nodeId: string, input: string): void

Returns void

remove

src/control-flow.ts

Removes the node from the control flow.

remove(nodeId: string): void

Returns void

Cancelled

src/utils/cancellable.ts

Cancelled exception. Thrown when reset is called while fetching data.

class Cancelled

Extends Error

ControlFlowNodeSetup

src/control-flow.ts

ControlFlowNodeSetup is a set of functions that define how to execute a node.

type ControlFlowNodeSetup<
  T extends ClassicScheme["Node"],
  I extends (keyof T["inputs"])[],
  O extends (keyof T["outputs"])[],
> = { inputs: Function; outputs: Function; execute: unknown };

DataflowNodeSetup

src/dataflow.ts

DataflowNodeSetup is a set of functions that define how to process a node.

type DataflowNodeSetup<
  T extends ClassicScheme["Node"],
  I extends { [key in keyof T["inputs"]]: any },
  O extends { [key in keyof T["outputs"]]: any },
> = { inputs: Function; outputs: Function; data: unknown };