Base Queue options
Condition to start processor at instance creation.
Denotes commands should retry indefinitely.
Amount of jobs that a single worker is allowed to work on in parallel.
Options for connecting to a Redis instance.
Number of seconds to long poll for jobs when the queue is empty.
Enable rate limiter
Duration of the lock for the job in milliseconds. The lock represents that a worker is processing the job. If the lock is lost, the job will be eventually be picked up by the stalled checker and move back to wait so that another worker can process it again.
The time in milliseconds before the lock is automatically renewed.
It is not recommended to modify this value, which is by default set to halv the lockDuration value, which is optimal for most use cases.
Amount of times a job can be recovered from a stalled state
wait state. If this is exceeded, the job is moved
Enable collect metrics.
Optional worker name. The name will be stored on every job processed by this worker instance, and can be used to monitor which worker is processing or has processed a given job.
Prefix for all queue keys.
You can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the completed set.
You can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the failed set.
This is an internal option that should not be modified.
More advanced options.
Skip lock renewal for this worker. If set to true, the lock will expire after lockDuration and moved back to the wait queue (if the stalled check is not disabled)
Skip stalled check for this worker. Note that other workers could still perform stalled checkd and move jobs back to wait for jobs being processed by this worker.
Avoid version validation to be greater or equal than v5.0.0.
Number of milliseconds between stallness checks.
Use Worker Threads instead of Child Processes. Note: This option can only be used when specifying a file for the processor argument.
Generated using TypeDoc