Node/
API Reference
The Node.js SDK public surface — classes, methods, and the CLI.
The Node.js SDK public surface — classes, methods, and the CLI.
The public API exported from the @byteveda/flexiq barrel. Contrib helpers live
under @byteveda/flexiq/contrib/* (see Integrations).
| Page | Covers |
|---|---|
| Overview | How the SDK is layered, the module map, the package surface. |
| Queue | Construct, enqueue, inspect, manage, locks, periodic, webhooks. |
| Task | queue.task registration and per-task config. |
| Worker | runWorker options and the worker handle. |
| Result | Awaiting results and the result waiter. |
| Context | currentJob() — signal, progress, ids. |
| Serializers | JsonSerializer, MsgpackSerializer, CborSerializer, the Serializer interface. |
| Workflows | The workflow builder + run handle. |
| Canvas | chain, group, chord — builder shorthands for common DAG shapes. |
| Saga | compensate, the saga run/node states, the rollback contract. |
| Batching | enqueueMany and Batcher — many enqueues in one round-trip. |
| Testing | mockResource — stub an injected resource in tests. |
| Errors | The FlexiQError hierarchy. |
| CLI | The flexiq command. |