Interface RedisQueueOptions

Injected Redis client (bypasses lazy import).

Bound on one Redis command, in milliseconds (adapter 'redis' only; ignored by every other adapter). Default 15000; 0 disables it. A paused or partitioned server keeps its socket open, so without a bound a command waits forever; with it add() rejects and a poll records the failure. Applied as ioredis commandTimeout to the client the adapter BUILDS — never to an injected client, which keeps its own configuration. A value outside 0–2147483647 (including NaN) throws RangeError.

A timeout rejects the command LOCALLY; the server may still apply it once it answers. So a rejected add() is not proof the job was not enqueued — a caller that retries on rejection can run the job twice, and should give the job an idempotent handler. Each queue transition runs as one Lua script (see IRedisQueueClient.eval), so a timeout leaves it whole or absent; a reserve applied after its timeout leaves the job and its payload in the processing set. With eval, an expired lease is reclaimed on reserve. A client without eval keeps the previous behaviour: no claims or reclaim.

Receives the connection errors (ioredis 'error' events) of the client the adapter BUILDS, instead of ioredis printing each reconnect failure to the console. Never attached to an injected client, which belongs to the caller. QueuePlugin supplies one backed by its logger.

How long a dead-lettered job's payload is retained, in milliseconds; see QueuePluginOptions.deadLetterTtlMs.

Redis key namespace, default queue:. Non-empty, at most 128 characters, without control characters. Set per application for shared Redis isolation; no prefix on one Redis may be a string prefix of another (app: and app:b: collide through a job named b:x).

Redis connection URL (default 'redis://localhost:6379').

Redis lease length in ms, default 30000; from 1000 to 2147483647. Requires eval; otherwise inactive with one connection-error report. Renewed every third of this duration. Redis 5+ required.