Listen to 'active' event.
This event is triggered when a job enters the 'active' state, meaning it is being processed.
An object containing details about the job that became active.
The unique identifier of the job that entered the active state.
Optional prev?: stringThe previous state of the job before it became active (e.g., 'waiting'), if applicable.
The identifier of the event.
An object containing details about the job that became active.
The unique identifier of the job that entered the active state.
The previous state of the job before it became active (e.g., 'waiting'), if applicable.
The identifier of the event.
Listen to 'added' event.
This event is triggered when a job is created and added to the queue.
Listen to 'added' event.
This event is triggered when a job is created and added to the queue.
An object containing details about the newly added job.
The unique identifier of the job that was added.
The name of the job, typically indicating its type or purpose.
The identifier of the event.
An object containing details about the newly added job.
The unique identifier of the job that was added.
The name of the job, typically indicating its type or purpose.
The identifier of the event.
Listen to 'cleaned' event.
This event is triggered when jobs are cleaned (e.g., removed) from the queue, typically via a cleanup method.
Listen to 'cleaned' event.
This event is triggered when jobs are cleaned (e.g., removed) from the queue, typically via a cleanup method.
An object containing the count of cleaned jobs.
The number of jobs that were cleaned, represented as a string due to Redis serialization.
The identifier of the event.
An object containing the count of cleaned jobs.
The number of jobs that were cleaned, represented as a string due to Redis serialization.
The identifier of the event.
Listen to 'completed' event.
This event is triggered when a job has successfully completed its execution.
Listen to 'completed' event.
This event is triggered when a job has successfully completed its execution.
An object containing details about the completed job.
The unique identifier of the job that completed.
Optional prev?: stringThe previous state of the job before completion (e.g., 'active'), if applicable.
The return value of the job, serialized as a string.
The identifier of the event.
An object containing details about the completed job.
The unique identifier of the job that completed.
The return value of the job, serialized as a string.
The previous state of the job before completion (e.g., 'active'), if applicable.
The identifier of the event.
Listen to 'debounced' event.
Listen to 'debounced' event.
An object containing details about the debounced job.
The identifier used to debounce the job, preventing duplicate processing.
The unique identifier of the job that was debounced.
The identifier of the event.
Use the 'deduplicated' event instead.
This event is triggered when a job is debounced because a job with the same debounceId still exists.
Use the 'deduplicated' event instead.
This event is triggered when a job is debounced because a job with the same debounceId still exists.
An object containing details about the debounced job.
The unique identifier of the job that was debounced.
The identifier used to debounce the job, preventing duplicate processing.
The identifier of the event.
Listen to 'deduplicated' event.
This event is triggered when a job is not added to the queue because a job with the same deduplicationId already exists.
Listen to 'deduplicated' event.
This event is triggered when a job is not added to the queue because a job with the same deduplicationId already exists.
An object containing details about the deduplicated job.
The unique identifier of the existing job that caused the deduplication.
The deduplication identifier that caused the job to be deduplicated.
The unique identifier of the job that was attempted to be added.
The identifier of the event.
An object containing details about the deduplicated job.
The unique identifier of the job that was attempted to be added.
The deduplication identifier that caused the job to be deduplicated.
The unique identifier of the existing job that caused the deduplication.
The identifier of the event.
Listen to 'delayed' event.
This event is triggered when a job is scheduled with a delay before it becomes active.
Listen to 'delayed' event.
This event is triggered when a job is scheduled with a delay before it becomes active.
An object containing details about the delayed job.
The delay duration in milliseconds before the job becomes active.
The unique identifier of the job that was delayed.
The identifier of the event.
An object containing details about the delayed job.
The unique identifier of the job that was delayed.
The delay duration in milliseconds before the job becomes active.
The identifier of the event.
Listen to 'drained' event.
This event is triggered when the queue has drained its waiting list, meaning there are no jobs in the 'waiting' state. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.
Listen to 'drained' event.
This event is triggered when the queue has drained its waiting list, meaning there are no jobs in the 'waiting' state. Note that there could still be delayed jobs waiting their timers to expire and this event will still be triggered as long as the waiting list has emptied.
The identifier of the event.
The identifier of the event.
Listen to 'duplicated' event.
This event is triggered when a job is not created because a job with the same identifier already exists.
Listen to 'duplicated' event.
This event is triggered when a job is not created because a job with the same identifier already exists.
An object containing the job identifier.
The unique identifier of the job that was attempted to be added.
The identifier of the event.
An object containing the job identifier.
The unique identifier of the job that was attempted to be added.
The identifier of the event.
Listen to 'error' event.
This event is triggered when an error in the Redis backend is thrown.
Listen to 'error' event.
This event is triggered when an error in the Redis backend is thrown.
Listen to 'failed' event.
This event is triggered when a job fails by throwing an exception during execution.
Listen to 'failed' event.
This event is triggered when a job fails by throwing an exception during execution.
An object containing details about the failed job.
The reason or message describing why the job failed.
The unique identifier of the job that failed.
Optional prev?: stringThe previous state of the job before failure (e.g., 'active'), if applicable.
The identifier of the event.
An object containing details about the failed job.
The unique identifier of the job that failed.
The reason or message describing why the job failed.
The previous state of the job before failure (e.g., 'active'), if applicable.
The identifier of the event.
Listen to 'ioredis:close' event.
This event is triggered when ioredis is closed.
Listen to 'ioredis:close' event.
This event is triggered when ioredis is closed.
Listen to 'paused' event.
This event is triggered when the queue is paused, halting the processing of new jobs.
Listen to 'paused' event.
This event is triggered when the queue is paused, halting the processing of new jobs.
An empty object (no additional data provided).
The identifier of the event.
An empty object (no additional data provided).
The identifier of the event.
Listen to 'progress' event.
This event is triggered when a job updates its progress via the Job#updateProgress() method, allowing
progress or custom data to be communicated externally.
Listen to 'progress' event.
This event is triggered when a job updates its progress via the Job#updateProgress() method, allowing
progress or custom data to be communicated externally.
An object containing the job identifier and progress data.
The progress data, which can be a number (e.g., percentage) or an object with custom data.
The unique identifier of the job reporting progress.
The identifier of the event.
An object containing the job identifier and progress data.
The unique identifier of the job reporting progress.
The progress data, which can be a number (e.g., percentage) or an object with custom data.
The identifier of the event.
Listen to 'removed' event.
This event is triggered when a job is manually removed from the queue.
Listen to 'removed' event.
This event is triggered when a job is manually removed from the queue.
An object containing details about the removed job.
The unique identifier of the job that was removed.
The previous state of the job before removal (e.g., 'active' or 'waiting').
The identifier of the event.
An object containing details about the removed job.
The unique identifier of the job that was removed.
The previous state of the job before removal (e.g., 'active' or 'waiting').
The identifier of the event.
Listen to 'resumed' event.
This event is triggered when the queue is resumed, allowing job processing to continue.
Listen to 'resumed' event.
This event is triggered when the queue is resumed, allowing job processing to continue.
An empty object (no additional data provided).
The identifier of the event.
An empty object (no additional data provided).
The identifier of the event.
Listen to 'retries-exhausted' event.
This event is triggered when a job has exhausted its maximum retry attempts after repeated failures.
Listen to 'retries-exhausted' event.
This event is triggered when a job has exhausted its maximum retry attempts after repeated failures.
An object containing details about the job that exhausted retries.
The number of retry attempts made, represented as a string (due to Redis serialization).
The unique identifier of the job that exhausted its retries.
The identifier of the event.
An object containing details about the job that exhausted retries.
The unique identifier of the job that exhausted its retries.
The number of retry attempts made, represented as a string (due to Redis serialization).
The identifier of the event.
Listen to 'stalled' event.
This event is triggered when a job moves from 'active' back to 'waiting' or 'failed' because the processor could not renew its lock, indicating a potential processing issue.
Listen to 'stalled' event.
This event is triggered when a job moves from 'active' back to 'waiting' or 'failed' because the processor could not renew its lock, indicating a potential processing issue.
An object containing the job identifier.
The unique identifier of the job that stalled.
The identifier of the event.
An object containing the job identifier.
The unique identifier of the job that stalled.
The identifier of the event.
Listen to 'waiting' event.
This event is triggered when a job enters the 'waiting' state, indicating it is queued and awaiting processing.
Listen to 'waiting' event.
This event is triggered when a job enters the 'waiting' state, indicating it is queued and awaiting processing.
An object containing details about the job in the waiting state.
The unique identifier of the job that is waiting.
Optional prev?: stringThe previous state of the job before entering 'waiting' (e.g., 'stalled'), if applicable.
The identifier of the event.
An object containing details about the job in the waiting state.
The unique identifier of the job that is waiting.
The previous state of the job before entering 'waiting' (e.g., 'stalled'), if applicable.
The identifier of the event.
Listen to 'waiting-children' event.
This event is triggered when a job enters the 'waiting-children' state, indicating it is waiting for its child jobs to complete.
Listen to 'waiting-children' event.
This event is triggered when a job enters the 'waiting-children' state, indicating it is waiting for its child jobs to complete.
An object containing the job identifier.
The unique identifier of the job waiting for its children.
The identifier of the event.
An object containing the job identifier.
The unique identifier of the job waiting for its children.
The identifier of the event.
Generated using TypeDoc
Listen to 'active' event.
This event is triggered when a job enters the 'active' state, meaning it is being processed.