queue-jobs-worker 1.0.2 → 1.0.4

package/README.md

@@ -1,51 +1,35 @@
+![queue-jobs-worker](./assets/queue-jobs-worker-github.png)
+
 # queue-jobs-worker
 
-A production-ready background job queue for Node.js — persistent, reliable, and TypeScript-first.
+A durable, TypeScript-first job queue for Node.js built for asynchronous work, retries, scheduling, and recovery. It based on multiple storage adapter with postgresql, mysql, redis also in-memory support for dev/testing.
 
-[![npm version](https://img.shields.io/npm/v/queue-jobs-worker.svg)](https://www.npmjs.com/package/queue-jobs-worker)
-[![license](https://img.shields.io/npm/l/queue-jobs-worker.svg)](./LICENSE)
-[![node](https://img.shields.io/node/v/queue-jobs-worker.svg)](https://nodejs.org)
+<p align="center">
+  <a href="https://www.npmjs.com/package/queue-jobs-worker">
+    <img src="https://img.shields.io/npm/v/queue-jobs-worker.svg" alt="npm version">
+  </a>&nbsp;
+  <a href="./LICENSE">
+    <img src="https://img.shields.io/npm/l/queue-jobs-worker.svg" alt="license">
+  </a>&nbsp;
+  <a href="https://nodejs.org">
+    <img src="https://img.shields.io/node/v/queue-jobs-worker.svg" alt="node">
+  </a>
+</p>
 
 ---
 
 ## Overview
 
-`queue-jobs-worker` lets you push work into a persistent queue and process it in the background — outside the main request lifecycle. You define the processor; the library handles everything else: queueing, persistence, retries, scheduling, concurrency, and failure recovery.
-
-For a full breakdown of every feature, see [FEATURES.md](./FEATURES.md).
+`queue-jobs-worker` helps you move background work out of the request lifecycle and into a reliable, persistent queue. Define the processor logic once and let the library handle enqueueing, persistence, retries, schedules, concurrency, rate limiting, and recovery.
 
-**Supports:**
-- In-memory (dev / testing)
-- Redis (node-redis v4+)
-- PostgreSQL (node-postgres / pg)
-- MySQL (mysql2)
+It supports all major local and production-friendly backends:
 
----
+- In-memory queue for development and tests
+- Redis via `node-redis` v4+
+- PostgreSQL via `pg`
+- MySQL via `mysql2`
 
-## Table of Contents
-
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Dialects](#dialects)
-  - [Memory](#memory-no-setup-required)
-  - [Redis](#redis)
-  - [PostgreSQL](#postgresql)
-  - [MySQL](#mysql)
-- [Core Concepts](#core-concepts)
-- [Configuration](#configuration)
-- [Enqueueing Jobs](#enqueueing-jobs)
-- [Processing Jobs](#processing-jobs)
-- [Workers](#workers)
-- [Events](#events)
-- [Querying Jobs](#querying-jobs)
-- [Retry & Backoff](#retry--backoff)
-- [Scheduling](#scheduling)
-- [Priority](#priority)
-- [Rate Limiting](#rate-limiting)
-- [Dead Letter Queue](#dead-letter-queue)
-- [Graceful Shutdown](#graceful-shutdown)
-- [Custom Storage Adapter](#custom-storage-adapter)
-- [API Reference](#api-reference)
+For a detailed feature breakdown, see [FEATURES.md](./FEATURES.md).
 
 ---
 
@@ -55,7 +39,7 @@ For a full breakdown of every feature, see [FEATURES.md](./FEATURES.md).
 npm install queue-jobs-worker
 ```
 
-Install only the driver(s) you actually use:
+Install the driver you plan to use:
 
 ```bash
 # Redis
@@ -72,44 +56,15 @@ npm install mysql2
 
 ## Quick Start
 
-**TypeScript**
-```ts
-import { QueueClient } from "queue-jobs-worker";
-
-const client = new QueueClient();
-
-// Generic type parameter gives you typed job.data
-const emails = client.createQueue<{ to: string; subject: string }>("emails");
-
-emails.process("send-email", async (job) => {
-  await sendEmail(job.data.to, job.data.subject);
-  // Throw to trigger retry; return to mark as completed
-});
-
-emails.createWorker({ concurrency: 5 });
-
-await emails.enqueue("send-email", {
-  to: "user@example.com",
-  subject: "Welcome!",
-});
-
-process.on("SIGTERM", async () => {
-  await client.close();
-  process.exit(0);
-});
-```
-
-**JavaScript**
 ```js
 const { QueueClient } = require("queue-jobs-worker");
 
 const client = new QueueClient();
-
-// No generic — job.data is untyped
 const emails = client.createQueue("emails");
 
 emails.process("send-email", async (job) => {
   await sendEmail(job.data.to, job.data.subject);
+  // Return to mark the job complete; throw to trigger retry or DLQ handling
 });
 
 emails.createWorker({ concurrency: 5 });
@@ -125,152 +80,46 @@ process.on("SIGTERM", async () => {
 });
 ```
 
----
-
-## Dialects
-
-### Memory (no setup required)
-
-Uses an in-process Map. Data is lost on restart. Perfect for development and tests.
-
-```js
-const client = new QueueClient();
-// or explicitly:
-const client = new QueueClient({ dialect: "memory" });
-```
-
-`init()` is optional for memory — it's a no-op. All other dialects require it.
+If you are using TypeScript, you can optionally make the queue payload type-safe with a generic like `client.createQueue<{ to: string; subject: string }>("emails")`.
 
 ---
 
-### Redis
+## Supported Backends
 
-Requires `redis` (node-redis v4+): `npm install redis`
+Pass `dialect` and `connectionString` to `QueueClient`. Call `await client.init()` to establish database connections and create required schema tables.
 
 ```js
-// TypeScript: import { QueueClient } from "queue-jobs-worker";
-const { QueueClient } = require("queue-jobs-worker");
-
-const client = new QueueClient({
-  dialect: "redis",
-  connectionString: "redis://localhost:6379",
-});
-
-await client.init(); // connects + PING — throws if unreachable
-
-const jobs = client.createQueue("jobs");
-```
-
-**With authentication:**
-```js
-const client = new QueueClient({
-  dialect: "redis",
-  connectionString: "redis://:yourpassword@redis-host:6379/0",
-});
-await client.init();
-```
+// 1. In-Memory (Default for local development & tests, no persistence)
+const client = new QueueClient({ dialect: "memory" });
 
-**With TLS (Redis Cloud, Upstash, etc.):**
-```js
+// 2. Redis (Supports standard redis://, TLS rediss://, and authentication)
 const client = new QueueClient({
   dialect: "redis",
-  connectionString: "rediss://user:password@host:6380",
+  connectionString: process.env.REDIS_URL || "redis://localhost:6379",
 });
-await client.init();
-```
-
-**What `init()` does for Redis:**
-- Creates the node-redis client
-- Calls `client.connect()`
-- Sends `PING` and asserts the response is `PONG`
-- Throws a descriptive error if the connection fails
-
-**Key structure in Redis** (prefix: `qjw:`):
-```
-qjw:job:{id}                  → Hash (all job fields)
-qjw:queue:{name}:waiting      → Sorted Set (score = -priority)
-qjw:queue:{name}:delayed      → Sorted Set (score = runAt ms)
-qjw:queue:{name}:active       → Set
-qjw:queue:{name}:completed    → Set
-qjw:queue:{name}:dead         → Set
-qjw:rate:{name}               → String (rate-limit counter)
-```
-
-Job claiming uses a **Lua script** so it is atomic — two concurrent workers can never claim the same job.
-
----
-
-### PostgreSQL
-
-Requires `pg` (node-postgres): `npm install pg`
-
-```js
-// TypeScript: import { QueueClient } from "queue-jobs-worker";
-const { QueueClient } = require("queue-jobs-worker");
 
+// 3. PostgreSQL (Auto-creates required queue tables on init)
 const client = new QueueClient({
   dialect: "postgres",
-  connectionString: "postgresql://user:password@localhost:5432/mydb",
+  connectionString: process.env.POSTGRES_URL || "postgresql://user:password@localhost:5432/mydb",
 });
 
-await client.init(); // connects + SELECT 1 + creates tables
-```
-
-**What `init()` does for PostgreSQL:**
-- Creates a connection pool (`pg.Pool`)
-- Runs `SELECT 1` to verify connectivity
-- Executes `CREATE TABLE IF NOT EXISTS` for `qjw_jobs` and `qjw_rate_limits` — **idempotent, safe to run on every startup**
-- Throws a descriptive error if the connection fails
-
-**Tables created automatically** (prefix: `qjw_`):
-```sql
-qjw_jobs          -- stores every job and its full lifecycle state
-qjw_rate_limits   -- sliding-window rate-limit counters
-```
-
-Claiming uses `SELECT ... FOR UPDATE SKIP LOCKED` inside a transaction — safe for any number of concurrent workers.
-
-**With SSL (Heroku, Supabase, Neon, etc.):**
-```js
-const client = new QueueClient({
-  dialect: "postgres",
-  connectionString: process.env.DATABASE_URL,
-  // pg respects ?sslmode=require in the connection string
-});
-await client.init();
-```
-
----
-
-### MySQL
-
-Requires `mysql2`: `npm install mysql2`
-
-```js
-// TypeScript: import { QueueClient } from "queue-jobs-worker";
-const { QueueClient } = require("queue-jobs-worker");
-
+// 4. MySQL (Auto-creates required queue tables on init)
 const client = new QueueClient({
   dialect: "mysql",
-  connectionString: "mysql://user:password@localhost:3306/mydb",
+  connectionString: process.env.MYSQL_URL || "mysql://user:password@localhost:3306/mydb",
 });
 
-await client.init(); // connects + SELECT 1 + creates tables
-```
-
-**What `init()` does for MySQL:**
-- Creates a connection pool (`mysql2.createPool`)
-- Runs `SELECT 1` to verify connectivity
-- Executes `CREATE TABLE IF NOT EXISTS` for `qjw_jobs` and `qjw_rate_limits` — **idempotent**
-- Throws a descriptive error if the connection fails
-
-**Tables created automatically** (prefix: `qjw_`):
-```sql
-qjw_jobs          -- full job state (InnoDB, utf8mb4)
-qjw_rate_limits   -- sliding-window rate-limit counters
+// Initialize backend connection (Required for Redis, PostgreSQL, MySQL)
+await client.init();
 ```
 
-Claiming uses `SELECT ... FOR UPDATE SKIP LOCKED` inside a transaction.
+| Dialect | Connection Format | `client.init()` Behavior |
+|---|---|---|
+| `memory` | N/A | No-op (transient memory store) |
+| `redis` | `redis://...`, `rediss://...` (TLS), Auth URL | Connects & verifies with `PING` |
+| `postgres` | `postgresql://user:pass@host:5432/dbname` | `SELECT 1` check & creates schema |
+| `mysql` | `mysql://user:pass@host:3306/dbname` | Connection check & creates schema |
 
 ---
 
@@ -278,26 +127,25 @@ Claiming uses `SELECT ... FOR UPDATE SKIP LOCKED` inside a transaction.
 
 | Concept | Description |
 |---|---|
-| `QueueClient` | Entry point — holds config, storage, and all queues |
-| `Queue` | An independent stream of jobs with its own config |
-| `Job` | A unit of work — passed to your processor |
-| `Worker` | Claims and executes jobs from a queue |
-| `Processor` | Your function — `async (job) => { ... }` |
-| `StorageAdapter` | Interface between the core and the database |
-| DLQ | Dead Letter Queue — permanently failed jobs land here |
+| `QueueClient` | Entry point that owns configuration, storage, and queues |
+| `Queue` | A separate job stream with its own settings |
+| `Job` | A unit of work passed to your processor |
+| `Worker` | Claims and executes jobs |
+| `Processor` | Your async function, e.g. `async (job) => { ... }` |
+| `StorageAdapter` | A backend abstraction for durable storage |
+| `DLQ` | Dead Letter Queue for permanently failed jobs |
 
 ---
 
 ## Configuration
 
-Config is layered — more specific settings override broader ones:
+Settings are layered so more specific config overrides broader defaults:
 
 ```
 Client defaults → Queue options → Worker options → Job options
 ```
 
 ```js
-// TypeScript: import { QueueClient } from "queue-jobs-worker";
 const { QueueClient } = require("queue-jobs-worker");
 
 const client = new QueueClient({
@@ -305,17 +153,17 @@ const client = new QueueClient({
   connectionString: process.env.REDIS_URL,
 
   defaults: {
-    attempts: 3,            // max retry attempts per job
-    retryDelay: 1000,       // base retry delay in ms
-    backoff: "exponential", // "fixed" | "linear" | "exponential"
-    timeout: 30_000,        // per-attempt timeout in ms
-    concurrency: 10,        // worker concurrency
-    pollInterval: 1_000,    // how often workers poll for new jobs (ms)
-    stalledInterval: 30_000,// how often to check for stalled jobs (ms)
-    lockDuration: 60_000,   // how long a job lock is valid (ms)
+    attempts: 3,
+    retryDelay: 1000,
+    backoff: "exponential",
+    timeout: 30_000,
+    concurrency: 10,
+    pollInterval: 1_000,
+    stalledInterval: 30_000,
+    lockDuration: 60_000,
     rateLimit: {
       max: 100,
-      duration: 60_000,     // 100 jobs per minute
+      duration: 60_000,
     },
   },
 });
@@ -327,24 +175,6 @@ await client.init();
 
 ## Enqueueing Jobs
 
-**TypeScript**
-```ts
-// Generic type gives you autocomplete and type-safety on job.data
-const queue = client.createQueue<{ userId: string }>("notifications");
-
-await queue.enqueue("send-push", { userId: "u_123" });
-
-// With options
-await queue.enqueue("send-push", { userId: "u_123" }, {
-  attempts: 5,
-  retryDelay: 2000,
-  backoff: "linear",
-  timeout: 10_000,
-  priority: 10,      // higher = processed first (default: 0)
-});
-```
-
-**JavaScript**
 ```js
 const queue = client.createQueue("notifications");
 
@@ -359,24 +189,32 @@ await queue.enqueue("send-push", { userId: "u_123" }, {
 });
 ```
 
+If you want TypeScript type safety for `job.data`, pass a generic when creating the queue, such as `client.createQueue<{ userId: string }>("notifications")`.
+
 ---
 
 ## Processing Jobs
 
-Register a processor before starting the worker:
+Register a processor before creating or starting a worker. Processors receive the `job` instance as well as an `AbortSignal` for cooperative cancellation when a job attempt times out:
 
 ```js
-queue.process("send-push", async (job) => {
+queue.process("send-push", async (job, signal) => {
   const { userId } = job.data;
 
-  await pushService.send(userId, "You have a new message");
+  // Pass signal to APIs that support cancellation (e.g. fetch, DB queries):
+  await pushService.send(userId, "You have a new message", { signal });
+
+  // Or check signal.aborted before performing expensive steps:
+  if (signal.aborted) return;
 
-  // Return to mark as completed.
-  // Throw any error to mark as failed (triggers retry or DLQ).
+  // Return to mark the job complete.
+  // Throw any error to trigger retry logic or DLQ handling.
 });
 ```
 
-For the full list of `job` fields and helper methods, see [FEATURES.md → Job Identity & Metadata](./FEATURES.md#job-identity--metadata).
+> **Note on Timeout Cancellation**: In Node.js, asynchronous operations cannot be forcibly terminated from the outside. Processors should cooperate with cancellation by checking `signal.aborted` or forwarding `signal` to abortable APIs to ensure timed-out executions do not continue running in the background.
+
+See [FEATURES.md](./FEATURES.md) for the full `job` model and helper methods.
 
 ---
 
@@ -384,42 +222,40 @@ For the full list of `job` fields and helper methods, see [FEATURES.md → Job I
 
 ```js
 const worker = queue.createWorker({
-  concurrency: 10,          // max simultaneous jobs
-  shutdownTimeout: 30_000,  // ms to wait for active jobs during shutdown
+  concurrency: 10,
+  shutdownTimeout: 30_000,
 });
 
-console.log(worker.status); // "idle" | "running" | "stopping" | "stopped"
-console.log(worker.id);     // unique worker ID
+console.log(worker.status);
+console.log(worker.id);
 
 await worker.stop();
 ```
 
-You can create multiple workers on the same queue — they coordinate through the storage layer:
+Multiple workers can share the same queue and coordinate through the storage layer:
 
 ```js
 const w1 = queue.createWorker({ concurrency: 5 });
 const w2 = queue.createWorker({ concurrency: 5 });
-// Total capacity: 10 concurrent jobs
+// total capacity: 10 concurrent jobs
 ```
 
 ---
 
 ## Events
 
-All lifecycle events are emitted on the client. Subscribe before creating queues/workers:
+The client emits lifecycle events that are useful for monitoring and alerting:
 
 ```js
 client.on("job:completed", (job) => console.log("Done:", job.id));
-client.on("job:failed",    (job, err) => console.error("Failed:", job.id, err.message));
-client.on("job:dead",      (job, err) => console.error("DLQ:", job.id, err.message));
-client.on("worker:error",  (workerId, err) => console.error("Worker error:", err));
+client.on("job:failed", (job, err) => console.error("Failed:", job.id, err.message));
+client.on("job:dead", (job, err) => console.error("DLQ:", job.id, err.message));
+client.on("worker:error", (workerId, err) => console.error("Worker error:", err));
 
-client.off("job:completed", myListener);  // remove a listener
-client.once("job:dead", (job, err) => alertTeam(job, err));  // one-time listener
+client.off("job:completed", myListener);
+client.once("job:dead", (job, err) => alertTeam(job, err));
 ```
 
-For the full event reference (all job, worker, and system events), see [FEATURES.md → Event System](./FEATURES.md#event-system).
-
 ---
 
 ## Querying Jobs
@@ -430,13 +266,11 @@ if (job) {
   console.log(job.status, job.attemptsMade);
 }
 
-// Jobs by status (paginated)
-const waiting   = await queue.getJobs("waiting", 50, 0);   // limit, offset
-const active    = await queue.getJobs("active");
+const waiting = await queue.getJobs("waiting", 50, 0);
+const active = await queue.getJobs("active");
 const completed = await queue.getJobs("completed", 100, 0);
-const dead      = await queue.getJobs("dead");
+const dead = await queue.getJobs("dead");
 
-// Counts per status
 const counts = await queue.getJobCounts();
 // {
 //   waiting: 12,
@@ -451,17 +285,15 @@ const counts = await queue.getJobCounts();
 
 ## Retry & Backoff
 
-Control retry behaviour at the client, queue, or job level:
+Retries can be configured at the client, queue, or job level:
 
 ```js
-// Queue-level
 const queue = client.createQueue("tasks", {
   attempts: 5,
   retryDelay: 2000,
   backoff: "exponential",
 });
 
-// Job-level override
 await queue.enqueue("task", payload, {
   attempts: 3,
   retryDelay: 500,
@@ -469,57 +301,50 @@ await queue.enqueue("task", payload, {
 });
 ```
 
-Three strategies are available: `fixed`, `linear`, and `exponential`. Each failed attempt is recorded in `job.attemptHistory`. See [FEATURES.md → Retry & Backoff](./FEATURES.md#retry--backoff) for strategy formulas and details.
+Available strategies are `fixed`, `linear`, and `exponential`. Each failure is tracked in `job.attemptHistory` so you can inspect what happened without losing context.
 
 ---
 
 ## Scheduling
 
 ```js
-// Relative delay
 await queue.enqueue("reminder", payload, { schedule: { delay: 30_000 } });
-
-// Absolute timestamp
 await queue.enqueue("report", payload, { schedule: { runAt: "2026-09-01T09:00:00Z" } });
-
-// Cron expression (stored for recurring jobs)
 await queue.enqueue("cleanup", payload, { schedule: { cron: "0 3 * * *" } });
 ```
 
-Delayed jobs are not eligible until their `runAt` time. See [FEATURES.md → Scheduling](./FEATURES.md#scheduling) for details on how each adapter handles promotion.
+Delayed jobs stay dormant until their scheduled time is reached.
 
 ---
 
 ## Priority
 
-Higher values are processed first. Default is `0`.
+Jobs with a higher priority value are processed sooner. The default is `0`.
 
 ```js
 await queue.enqueue("urgent-task", payload, { priority: 100 });
 await queue.enqueue("normal-task", payload, { priority: 0 });
-await queue.enqueue("low-task",    payload, { priority: -10 });
-// Processing order: urgent → normal → low
+await queue.enqueue("low-task", payload, { priority: -10 });
+// order: urgent → normal → low
 ```
 
-See [FEATURES.md → Priority](./FEATURES.md#priority).
-
 ---
 
 ## Rate Limiting
 
 ```js
 const queue = client.createQueue("webhooks", {
-  rateLimit: { max: 50, duration: 60_000 }, // 50 jobs per minute
+  rateLimit: { max: 50, duration: 60_000 },
 });
 ```
 
-When the limit is reached, workers skip claiming until the window resets — jobs are never discarded. See [FEATURES.md → Rate Limiting](./FEATURES.md#rate-limiting).
+When a queue reaches its limit, workers pause claiming new jobs until the time window resets. Jobs are not discarded.
 
 ---
 
 ## Dead Letter Queue
 
-When a job exhausts all retry attempts it is moved to the DLQ (status: `"dead"`).
+When a job reaches the end of its retry budget, it is moved to the dead-letter queue with status `"dead"`.
 
 ```js
 client.on("job:dead", async (job, error) => {
@@ -529,64 +354,37 @@ client.on("job:dead", async (job, error) => {
 const deadJobs = await queue.getJobs("dead");
 ```
 
-Full attempt history is preserved on the job. See [FEATURES.md → Dead Letter Queue](./FEATURES.md#dead-letter-queue).
+All failure history remains attached to the job record.
 
 ---
 
 ## Graceful Shutdown
 
-Always call `client.close()` before your process exits:
+Call `client.close()` before your process exits:
 
 ```js
 process.on("SIGTERM", async () => {
-  await client.close(); // stops workers, releases locks, closes connections
+  await client.close();
   process.exit(0);
 });
+
 process.on("SIGINT", async () => {
   await client.close();
   process.exit(0);
 });
 ```
 
-Interrupted jobs remain recoverable via the stalled-job recovery mechanism. See [FEATURES.md → Graceful Shutdown](./FEATURES.md#graceful-shutdown).
+This stops workers cleanly, releases locks, and allows stalled-job recovery to continue safely after restarts.
 
 ---
 
 ## Custom Storage Adapter
 
-Implement the `StorageAdapter` interface to add your own backend:
-
-**TypeScript**
-```ts
-import type { StorageAdapter } from "queue-jobs-worker";
-
-class MongoStorageAdapter implements StorageAdapter {
-  async initialize() { /* connect, create indexes */ }
-  async close() { /* disconnect */ }
-  async enqueue(input) { /* ... */ }
-  async claim(input) { /* atomic claim */ }
-  async complete(jobId) { /* ... */ }
-  async requeue(input) { /* ... */ }
-  async moveToDlq(input) { /* ... */ }
-  async releaseLock(jobId) { /* ... */ }
-  async recoverStalledJobs(queue, now) { /* ... */ }
-  async getJob(jobId) { /* ... */ }
-  async getJobs(filter) { /* ... */ }
-  async getJobCounts(queue) { /* ... */ }
-  async checkAndIncrementRateLimit(queue, max, windowMs, now) { /* ... */ }
-}
-
-const client = QueueClient.withAdapter(new MongoStorageAdapter(), {
-  defaults: { attempts: 5 },
-});
-await client.init();
-```
+You can provide a custom backend by implementing the `StorageAdapter` interface. The same idea applies in JavaScript or TypeScript; the main difference is whether you add explicit interface typing in TypeScript.
 
-**JavaScript**
 ```js
 const { QueueClient } = require("queue-jobs-worker");
 
-// In JS there's no interface to implement — just match the method signatures
 class MongoStorageAdapter {
   async initialize() { /* connect, create indexes */ }
   async close() { /* disconnect */ }
@@ -606,6 +404,7 @@ class MongoStorageAdapter {
 const client = QueueClient.withAdapter(new MongoStorageAdapter(), {
   defaults: { attempts: 5 },
 });
+
 await client.init();
 ```
 
@@ -618,66 +417,64 @@ await client.init();
 | Option | Type | Default | Description |
 |---|---|---|---|
 | `dialect` | `"memory" \| "redis" \| "postgres" \| "mysql"` | `"memory"` | Storage backend |
-| `connectionString` | `string` | — | Required for redis/postgres/mysql |
-| `defaults.attempts` | `number` | `3` | Default max attempts |
-| `defaults.retryDelay` | `number` | `1000` | Default base retry delay (ms) |
-| `defaults.backoff` | `"fixed" \| "linear" \| "exponential"` | `"exponential"` | Default backoff strategy |
-| `defaults.timeout` | `number` | `30000` | Default per-attempt timeout (ms) |
+| `connectionString` | `string` | — | Required for Redis/PostgreSQL/MySQL |
+| `defaults.attempts` | `number` | `3` | Max retries per job |
+| `defaults.retryDelay` | `number` | `1000` | Base retry delay in ms |
+| `defaults.backoff` | `"fixed" \| "linear" \| "exponential"` | `"exponential"` | Retry strategy |
+| `defaults.timeout` | `number` | `30000` | Per-attempt timeout in ms |
 | `defaults.concurrency` | `number` | `10` | Default worker concurrency |
-| `defaults.pollInterval` | `number` | `1000` | Worker poll interval (ms) |
-| `defaults.stalledInterval` | `number` | `30000` | Stalled-job check interval (ms) |
-| `defaults.lockDuration` | `number` | `60000` | Lock TTL (ms) |
-| `defaults.rateLimit` | `{ max, duration }` | — | Optional rate limit |
+| `defaults.pollInterval` | `number` | `1000` | Poll interval in ms |
+| `defaults.stalledInterval` | `number` | `30000` | Stalled-job check interval in ms |
+| `defaults.lockDuration` | `number` | `60000` | Lock TTL in ms |
+| `defaults.rateLimit` | `{ max, duration }` | — | Optional rate limiting |
 
 ### `client.init()`
 
-Initialises the storage backend. Required for redis/postgres/mysql before any queue operations. Idempotent.
+Initializes the configured backend. This is required for Redis, PostgreSQL, and MySQL before queue operations. It is safe to call more than once.
 
 ### `client.createQueue<TPayload>(name, options?)`
 
-Creates and returns a `Queue`. `options` override `defaults` for this queue. The generic `<TPayload>` is TypeScript-only — omit it in JavaScript.
+Creates and returns a queue. Queue-specific options override client defaults.
 
 ### `client.getQueue<TPayload>(name)` / `client.requireQueue<TPayload>(name)`
 
-Returns an existing queue by name (`requireQueue` throws if not found).
+Fetches an existing queue by name. `requireQueue()` throws if none exists.
 
 ### `client.on(event, listener)` / `client.once(...)` / `client.off(...)`
 
-Subscribe/unsubscribe from lifecycle events.
+Registers and removes event listeners for queue and worker lifecycle events.
 
 ### `client.close()`
 
-Gracefully shut down. Safe to call multiple times.
+Stops workers and closes storage connections gracefully.
 
 ### `QueueClient.withAdapter(adapter, options?)`
 
-Static factory for custom storage adapters.
-
----
+Creates a client using a custom storage backend.
 
 ### `queue.enqueue(type, payload, options?)`
 
 | Option | Type | Description |
 |---|---|---|
-| `attempts` | `number` | Max attempts for this job |
-| `retryDelay` | `number` | Base retry delay (ms) |
-| `backoff` | `string` | Backoff strategy |
-| `timeout` | `number` | Per-attempt timeout (ms) |
-| `priority` | `number` | Higher = sooner (default: 0) |
-| `schedule.delay` | `number` | Delay before eligible (ms) |
+| `attempts` | `number` | Maximum attempts for this job |
+| `retryDelay` | `number` | Base retry delay in ms |
+| `backoff` | `string` | Retry backoff strategy |
+| `timeout` | `number` | Per-attempt timeout in ms |
+| `priority` | `number` | Higher values are processed first |
+| `schedule.delay` | `number` | Delay before the job becomes eligible |
 | `schedule.runAt` | `string \| number` | Absolute run time |
-| `schedule.cron` | `string` | Cron expression (stored) |
+| `schedule.cron` | `string` | Cron expression for recurring jobs |
 
 ### `queue.process(type, processor)`
 
-Register an async processor function for a job type.
+Registers an async processor for a job type. The processor signature is `async (job, signal) => ...`, where `signal` is an `AbortSignal` aborted when the per-attempt timeout is reached.
 
 ### `queue.createWorker(options?)`
 
 | Option | Type | Default | Description |
 |---|---|---|---|
-| `concurrency` | `number` | queue config | Max concurrent jobs |
-| `shutdownTimeout` | `number` | `30000` | Drain timeout on stop (ms) |
+| `concurrency` | `number` | queue config | Maximum simultaneous job executions |
+| `shutdownTimeout` | `number` | `30000` | Graceful shutdown wait time in ms |
 
 ### `queue.getJob(id)` / `queue.getJobs(status?, limit?, offset?)`
 ### `queue.getJobCounts()`
@@ -688,7 +485,7 @@ Register an async processor function for a job type.
 
 | Feature | Memory | Redis | PostgreSQL | MySQL |
 |---|:---:|:---:|:---:|:---:|
-| Persistence | | ✓ | ✓ | ✓ |
+| Persistence | — | ✓ | ✓ | ✓ |
 | Atomic claim | ✓ | ✓ (Lua) | ✓ (SKIP LOCKED) | ✓ (SKIP LOCKED) |
 | Priority ordering | ✓ | ✓ | ✓ | ✓ |
 | Delayed jobs | ✓ | ✓ | ✓ | ✓ |
@@ -703,9 +500,9 @@ Register an async processor function for a job type.
 
 ## Security
 
-- Job payloads are never logged by default.
-- Error messages do not include payload data.
-- Connection strings should always come from environment variables, not source code.
+- Job payloads are not logged by default.
+- Error messages do not expose payload data.
+- Connection strings should come from environment variables rather than source code.
 - See [SECURITY.md](./SECURITY.md) for the full policy.
 
 ```js
@@ -726,7 +523,7 @@ const client = new QueueClient({
 
 ## Contributing
 
-See [CONTRIBUTING.md](./CONTRIBUTING.md).
+Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.
 
 ---
 
@@ -736,6 +533,6 @@ MIT — [LICENSE](./LICENSE)
 
 ## Donation
 
-If you find this project useful, you can support me with a coffee.
+If this project has been useful to you, consider supporting it with a coffee.
 
 **BTC:** `12dxgVQ3sRFhc4g7M6oydsN2tTMMthJJqS`