JavaScript

Use bigstate.client.javascript to configure resources over HTTP and receive updates over WebSocket delivery. These guides cover the two halves of the loop: publish state from Node.js, then consume it in a browser or another process.

What the client does#

The package talks to BigState in two ways:

  • HTTP — create and update objects, set state, and read the latest or a specific version.
  • WebSocket delivery — open a connection, subscribe to a delivery configuration, and receive matching state updates as they happen.

HTTP remains the source of truth. Delivery notifies you that something changed; you can always re-fetch state when you need the authoritative value.

Node.js (publish) → BigState → browser / client (delivery or HTTP read)

What you need#

  • Account and credentials — owner and an API key
  • Node.js 22.12 or later (for the quickstart and setup scripts)
  • A modern browser (for the delivery example)

Use write-capable API keys only in trusted environments. For browser subscribers, use a credential scoped to connect and receive updates.

Complete these pages in order:

Quickstart leaves you with a named object and at least one published state. Delivery builds on that object so you can watch live updates or pull state on demand.

After these guides#

When the publish/subscribe path works, try a fuller app or look up API details:

© 2024 BigState