Example Filter

Node ID: exampleFilter · Role: Filter · Realtime config: no

Description

Demo filter that passes all received data through unchanged. Serves as a template for implementing custom filters.

Inputs / Outputs

Inputs: Any
Outputs: Any

Config aliases

ExampleFilter, exampleFilter

Properties

No user-facing properties.

Example node definition

A full node definition in config.json looks like the block below. Paste it under the sinks key of your config, keyed by the node’s instance name (any identifier; it doesn’t have to match the node ID).

{
  "sinks": {
    "exampleFilter": {
      "dataEndpoint": "inproc://exampleFilter_data",
      "inputEndpoints": [],
      "settings": {}
    }
  }
}

Field reference

Field	Purpose
`dataEndpoint`	Endpoint this node binds to publish its output. Omit to let the runtime generate one.
`inputEndpoints`	List of upstream endpoints this node connects to (`outEndpoint` / `dataEndpoint` values from upstream nodes).
`inputDataFilter`	Optional whitelist of data types. Messages whose type isn’t in the list are dropped at the subscriber.
`settings`	All user-configurable fields — see the Properties table above.

Connections can also be declared at the top-level connections array when settings.explicitConnections is true, as an alternative to filling inputEndpoints on each node.

Loading documentation…