bullmq - v5.64.0
    Preparing search index...

    Interface QueueListener<JobBase>

    interface QueueListener<JobBase extends Job = Job> {
        cleaned: (jobs: string[], type: string) => void;
        error: (err: Error) => void;
        "ioredis:close": () => void;
        paused: () => void;
        progress: (jobId: string, progress: JobProgress) => void;
        removed: (jobId: string) => void;
        resumed: () => void;
        waiting: (job: JobBase) => void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    cleaned error ioredis:close paused progress removed resumed waiting

    Properties

    cleaned: (jobs: string[], type: string) => void

    Listen to 'cleaned' event.

    This event is triggered when the queue calls clean method.

    error: (err: Error) => void

    Listen to 'error' event.

    This event is triggered when an error is thrown.

    "ioredis:close": () => void

    Listen to 'ioredis:close' event.

    This event is triggered when ioredis is closed.

    paused: () => void

    Listen to 'paused' event.

    This event is triggered when the queue is paused.

    progress: (jobId: string, progress: JobProgress) => void

    Listen to 'progress' event.

    This event is triggered when the job updates its progress.

    removed: (jobId: string) => void

    Listen to 'removed' event.

    This event is triggered when a job is removed.

    resumed: () => void

    Listen to 'resumed' event.

    This event is triggered when the queue is resumed.

    waiting: (job: JobBase) => void

    Listen to 'waiting' event.

    This event is triggered when the queue creates a new job.

    Settings

    Member Visibility

    On This Page

    Properties