workflow.node_2.md

February 13, 2024 ยท View on GitHub

Home > @datashaper/workflow > Node_2

Node_2 interface

A graph processing node

Signature:

export interface Node<T, Config = unknown> 

Properties

PropertyModifiersTypeDescription
bindingsreadonlyNodeBinding<T>[]Gets all input bindings
bindings$readonlyObservable<NodeBinding<T>[]>An observable of the input bindings
configMaybe<Config>The node's mutable configuration
config$readonlyObservable<Maybe<Config>>A configuration observable
idreadonlyNodeIdA unique identifier for this node
inputsreadonlySocketName[]Named input sockets
statsreadonlyNodeStatsThe diagnostic statistics for this node

Methods

MethodDescription
bind(binding)Binds an input socket to an upstream node
binding(input)Retrieves an existing input binding by id
output(name)Gets a current output value
output$(name)Gets the output value stream
unbind(name)Clear an input socket