Installation

Install the Node.js SDK — prebuilt native binaries, dual ESM/CJS, three backends.

The Node.js SDK is a thin napi-rs shell over the FlexiQ Rust core — peer to the Python SDK, with no Python dependency.

bash

pnpm add @byteveda/flexiq

Requires Node.js >= 20. Ships as dual ESM + CommonJS with bundled type definitions.

Prebuilt native binaries

A prebuilt native addon is installed automatically for your platform via an optional per-platform package (@byteveda/flexiq-<os>-<arch>):

linux x64 / arm64 (gnu + musl)
macOS x64 / arm64
Windows x64

On a platform without a prebuilt, build from source with the Rust toolchain + the napi-rs CLI:

bash

pnpm build:native

The native crate lives at crates/flexiq-node; build:native compiles it with the postgres,redis,workflows,mesh cargo features enabled.

Pick a backend

import { Queue } from "@byteveda/flexiq";

new Queue({ dbPath: "flexiq.db" });                                   // SQLite (default)
new Queue({ backend: "postgres", dsn: process.env.PG_URL, schema: "flexiq" });
new Queue({ backend: "redis", dsn: "redis://localhost", prefix: "flexiq" });

SQLite needs nothing else — the whole queue lives in one file. See Backends for when to reach for Postgres or Redis. Next: the quickstart.