JobQueueOptions

JobQueueOptions

Options related to the built-in job queue.

Signature

interface JobQueueOptions {
  jobQueueStrategy?: JobQueueStrategy;
  jobBufferStorageStrategy?: JobBufferStorageStrategy;
  activeQueues?: string[];
  enableWorkerHealthCheck?: boolean;
}

Members

jobQueueStrategy

property
Defines how the jobs in the queue are persisted and accessed.

jobBufferStorageStrategy

property

activeQueues

property
type:
string[]
Defines the queues that will run in this process. This can be used to configure only certain queues to run in this process. If its empty all queues will be run. Note: this option is primarily intended to apply to the Worker process. Jobs will always get published to the queue regardless of this setting, but this setting determines whether they get processed or not.

enableWorkerHealthCheck

property
v1.3.0
type:
boolean
default:
false

When set to true, a health check will be run on the worker. This is done by adding a check-worker-health job to the job queue, which, when successfully processed by the worker, indicates that it is healthy.

Important Note: This health check is unreliable and can be affected by existing long running jobs, see this issue for further details. For this reason, the health check will be removed entirely in the next major version.