Optional
autorunCondition to start processor at instance creation.
true
Optional
blockingDenotes commands should retry indefinitely.
Optional
concurrencyAmount of jobs that a single worker is allowed to work on in parallel.
Options for connecting to a Redis instance.
Optional
drainNumber of seconds to long poll for jobs when the queue is empty.
5
Optional
limiterEnable rate limiter
Optional
lockDuration 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.
30000
Optional
lockThe 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.
Optional
maxAmount of times a job can be recovered from a stalled state
to the wait
state. If this is exceeded, the job is moved
to failed
.
1
Optional
metricsEnable collect metrics.
Optional
nameOptional 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.
Optional
prefixPrefix for all queue keys.
Optional
removeYou can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the completed set.
Optional
removeYou can provide an object specifying max age and/or count to keep. Default behavior is to keep the job in the failed set.
Optional
runThis is an internal option that should not be modified.
15000
Optional
settingsMore advanced options.
Optional
skipSkip 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)
false
Optional
skipSkip 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.
false
Optional
skipAvoid version validation to be greater or equal than v5.0.0.
false
Optional
stalledNumber of milliseconds between stallness checks.
30000
Optional
telemetryTelemetry Addon
Optional
useUse Worker Threads instead of Child Processes. Note: This option can only be used when specifying a file for the processor argument.
false
Optional
workerSupport passing Worker Fork Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as false (default value).
Optional
workerSupport passing Worker Threads Options. Note: This option can only be used when specifying a file for the processor argument and useWorkerThreads is passed as true.
Generated using TypeDoc
Base Queue options