JobQueueOptions interface

cluster?

[]

(Optional) Broker nodes to connect to, as host/port pairs. The broker is Redis.

drain?

boolean

(Optional) Drain jobs still being handled before shutting down on SIGTERM/SIGINT, instead of exiting from under them.

drainRequeue?

boolean

(Optional) Put jobs the drain gave up on back on the queue before exiting.

drainTimeout?

number

(Optional) Milliseconds a drain waits for jobs in flight before giving up on them. Ignored unless JobQueueOptions.drain is on.

logger?

ILogger

(Optional) Logger for the queue's own log and error messages.

name

string

Name of the job queue. Required.

This is the queue's identity, not a label: a JobQueueWorker and a JobQueuePublisher that share a name are two ends of one queue, and two that do not are unrelated queues that will never see each other's jobs.

password?

string

(Optional) Password for authenticating against the broker.

prefix?

string

(Optional) Prefix for every key this queue creates in the broker.

safe?

boolean

(Optional) Whether a job is handed to a worker under a lock, so that a worker dying before it starts does not take the job with it.

safeLockTtl?

number

(Optional) How long, in milliseconds, a job may sit checked out to a worker during safe delivery before it is treated as abandoned.

tls?

IMQOptions['tls']

(Optional) Encrypts the broker connection with TLS. true connects with Node's defaults, verifying the broker against the system trust store; an object is handed to tls.connect() as given, so supply ca for a private certificate authority and cert with key for mutual TLS.

username?

string

(Optional) Username for authenticating against the broker. Omit it on a broker that takes a password alone, which is the usual Redis setup.

verbose?

boolean

(Optional) Enables the queue's informational tracing.

verboseExtended?

boolean

(Optional) Adds message bodies to the verbose tracing.