Installation

Requirements

• Node.js 22 or later
• TypeScript 5.0+ (recommended)

Installation

1. Install the core package:

   npm

   npm install queuert

   pnpm

   pnpm add queuert

   yarn

   yarn add queuert

2. Install a state adapter (pick one):

   PostgreSQL

   Recommended for production. Supports horizontal scaling and all Queuert features. Requires PostgreSQL 14+.

   npm

   npm install @queuert/postgres

   pnpm

   pnpm add @queuert/postgres

   yarn

   yarn add @queuert/postgres

   SQLite

   Experimental Suitable for local development, CLI tools, and embedded applications. Requires SQLite 3.42+.

   npm

   npm install @queuert/sqlite

   pnpm

   pnpm add @queuert/sqlite

   yarn

   yarn add @queuert/sqlite

3. (Optional) Install a notify adapter for reduced latency:

   Redis

   Recommended for production. Uses Redis pub/sub with hint-based optimization to prevent thundering herd. Requires Redis 6+.

   npm

   npm install @queuert/redis

   pnpm

   pnpm add @queuert/redis

   yarn

   yarn add @queuert/redis

   NATS

   Experimental Uses NATS pub/sub. Supports revision-based CAS optimization when JetStream KV is available. Requires NATS 2.2+ (2.6+ for JetStream KV).

   npm

   npm install @queuert/nats

   pnpm

   pnpm add @queuert/nats

   yarn

   yarn add @queuert/nats

   PostgreSQL LISTEN/NOTIFY

   Uses PostgreSQL’s built-in LISTEN/NOTIFY. No additional infrastructure beyond your existing PostgreSQL database — already included in @queuert/postgres.

   npm

   npm install @queuert/postgres

   pnpm

   pnpm add @queuert/postgres

   yarn

   yarn add @queuert/postgres

   None (polling)

   Workers poll the database on a configurable interval. No extra packages or infrastructure required. Suitable for low-throughput workloads where millisecond latency is not critical.

4. (Optional) Install additional packages:

   npm

   npm install @queuert/dashboard  # Embeddable web UI for job observation
   npm install @queuert/otel       # OpenTelemetry metrics and tracing

   pnpm

   pnpm add @queuert/dashboard  # Embeddable web UI for job observation
   pnpm add @queuert/otel       # OpenTelemetry metrics and tracing

   yarn

   yarn add @queuert/dashboard  # Embeddable web UI for job observation
   yarn add @queuert/otel       # OpenTelemetry metrics and tracing

For detailed adapter configuration (ORM setup, driver options, provider interfaces), see the Integrations section.

Next up: Core Concepts — learn the building blocks before diving into guides.