Quickstart

Getting Started

Configure Wave Binder, connect your backend, and test a first flow with dependent nodes.

What is WaveBinder?
  • A dependency manager for complex data relationships.
  • It models data as graph nodes with explicit dependencies and uses RxJS for async/state flow.
  • It integrates with modern frontend frameworks like React, Vue, and Angular.
For complete node property details go to ProtoNodes Guide. For runtime methods go to API Reference.

1) Install the library

Show example 
npm install wave-binder

2) Configure external service (extapi.json)

Show example 
{
  "target": "http://localhost:3000/api",
  "secure": false,
  "authorization": null
}

3) Prepare protonodes.json (placeholder)

Show example 
[]

At this stage, keep the file empty. Node definition is handled in the WaveBinder ecosystem integration path (CLI wizard) or in the ProtoNodes Guide.

4) Initialize WaveBinder

Show example 
import { WaveBinder, ComplexNode } from "wave-binder";
import EXT_API_CONFIG from "./extapi.json";
import LICENSE from "./license.json";
import PROTO_NODES from "./protonodes.json";

const extApis = new Map();
extApis.set("api", EXT_API_CONFIG);

export const wb = new WaveBinder(LICENSE, PROTO_NODES, extApis, []);
wb.tangleNodes();
Important: the wb instance must be created in a shared accessible place (for example, a shared module/service singleton) and then reused. Avoid creating it inside components or functions that may run multiple times, otherwise you may get multiple instances and inconsistent state.
  • extApis.set("api", ...) registers the service referenced by serviceName: "api".
  • The key used in extApis.set("api", ...) must exactly match serviceName in nodes (e.g. "api").
  • If you change the key (e.g. "backend"), update nodes to serviceName: "backend" too.
  • wb.tangleNodes() connects dependencies and starts the reactive flow.

WaveBinder ecosystem integration

Beyond the wave-binder library, you can integrate official components to speed up setup and maintenance:

  • wavebinder-autodb-back: configurable CRUD backend to expose DB tables via API.
  • wave-binder-cli: CLI wizard to populate the protonodes.json file created in step 3 (guided node create/edit).
This page provides an overview only. Full setup, commands, and file configuration are in dedicated guides:

wave-binder-cli

Use the wizard to populate the previously created protonodes.json by adding/editing nodes in a guided flow.

Once you have defined nodes in protonodes

Runtime examples (SINGLE, MULTI, CUSTOM_FUNCTION) are available in the ProtoNodes Guide, in the dedicated practical examples section.