Skip to content

components/flow/FlowIR#

FlowIRBuilder#

Methods#

build()#

static build(
   nodes, 
   edges, 
   signatures): FlowIR;
Parameters#
Parameter Type
nodes Node<FlowNodeData<AttrsT>, T>[]
edges Edge[]
signatures Record<string, any>
Returns#

FlowIR


FlowIR#

Properties#

edges#

edges: FlowIREdge[];

metadata#

metadata: FlowMetadata;

nodes#

nodes: FlowIRNode[];

topology#

topology: FlowTopology;

FlowIRConnection#

Properties#

inputId#

inputId: string;

nodeId#

nodeId: string;

FlowIREdge#

Properties#

source#

source: string;

sourceHandle?#

optional sourceHandle?: string;

sourceOutput#

sourceOutput: string;

target#

target: string;

targetHandle?#

optional targetHandle?: string;

targetInput#

targetInput: string;

FlowIRInput#

Properties#

connected#

connected: boolean;

dtype#

dtype: string;

fallbackValue?#

optional fallbackValue?: any;

id#

id: string;

sourceNode?#

optional sourceNode?: string;

sourceOutput?#

optional sourceOutput?: string;

FlowIRNode#

Properties#

attrs#

attrs: Record<string, any>;

category?#

optional category?: string;

id#

id: string;

inputs#

inputs: FlowIRInput[];

outputs#

outputs: FlowIROutput[];

pluginId?#

optional pluginId?: string;

position?#

optional position?: {
  x: number;
  y: number;
};
x#
x: number;
y#
y: number;

type#

type: string;

FlowIROutput#

Properties#

connectedTo#

connectedTo: FlowIRConnection[];

dtype#

dtype: string;

id#

id: string;

FlowMetadata#

Properties#

complexity#

complexity: number;

edgeCount#

edgeCount: number;

errors#

errors: string[];

isValid#

isValid: boolean;

nodeCount#

nodeCount: number;

FlowTopology#

Properties#

cycles#

cycles: string[][];

depth#

depth: number;

endNodes#

endNodes: string[];

executionOrder#

executionOrder: string[];

startNodes#

startNodes: string[];