Optionalprocessor: string | Processor<DataType, ResultType, NameType>OptionalConnection: typeof RedisConnectionReadonlyidReadonlynameThe name of the queue.
ReadonlyoptsOptions for the queue.
Returns a promise that resolves to a redis client. Normally used only by subclasses.
Returns the version of the Redis instance the client is connected to,
Closes the worker and related redis connections.
This method waits for current jobs to finalize before returning.
Use force boolean parameter if you do not want to wait for current jobs to be processed.
Promise that resolves when the worker has been closed.
This function is exposed only for testing purposes.
Force disconnects a connection.
Emits an event. Normally used by subclasses to emit events.
The emitted event.
Returns a promise that resolves to the next job in queue.
worker token to be assigned to retrieved job
a Job or undefined if no job was available in the queue.
Checks if worker is paused.
true if worker is paused, false otherwise.
Checks if worker is currently running.
true if worker is running, false otherwise.
Pauses the processing of this queue only for this worker.
OptionaldoNotWaitActive: booleanResumes processing of this worker (if paused).
Waits until the worker is ready to start processing jobs. In general only useful when writing tests.
This class represents a worker that is able to process jobs from the queue. As soon as the class is instantiated and a connection to Redis is established it will start processing jobs.