bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Class QueueEvents<R, P>

    QueueEvents class for listening to queue events Provides a way to listen to events without processing jobs

    BullMQ v5 compatible events:

    • waiting: job added to queue
    • active: job started processing
    • completed: job completed successfully
    • failed: job failed
    • progress: job progress updated
    • stalled: job stalled (no heartbeat)
    • removed: job removed from queue
    • delayed: job moved to delayed state
    • duplicated: duplicate job detected
    • retried: job retried
    • waiting-children: job waiting for children to complete
    • drained: queue has no more waiting jobs
    • error: error occurred

    Type Parameters

    • R = unknown

      Type of the job result (for 'completed' event)

    • P = unknown

      Type of the progress data (for 'progress' event)

    Hierarchy

    • EventEmitter
      • QueueEvents
    Index
    • Type Parameters

      • R = unknown

        Type of the job result (for 'completed' event)

      • P = unknown

        Type of the progress data (for 'progress' event)

      Parameters

      • name: string

      Returns QueueEvents<R, P>

    name: string
    • Close the event listener and remove all listeners

      Returns void

    • Disconnect from the event stream. Alias for close() for BullMQ v5 compatibility.

      Returns Promise<void>

    • Emit an error event (can be called externally)

      Parameters

      • error: Error

      Returns void

    • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

      server.on('connection', (stream) => {
      console.log('someone connected!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

      import { EventEmitter } from 'node:events';
      const myEE = new EventEmitter();
      myEE.on('foo', () => console.log('a'));
      myEE.prependListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      // b
      // a

      Parameters

      • event: "waiting"
      • listener: (data: WaitingEvent) => void

        The callback function

      Returns this

      v0.1.101

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      • event: "paused" | "resumed"
      • listener: (data: Record<string, never>) => void

      Returns this

    • Parameters

      • event: "error"
      • listener: (error: Error, event?: JobEvent) => void

      Returns this

    • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

      server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
      });

      Returns a reference to the EventEmitter, so that calls can be chained.

      By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

      import { EventEmitter } from 'node:events';
      const myEE = new EventEmitter();
      myEE.once('foo', () => console.log('a'));
      myEE.prependOnceListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      // b
      // a

      Parameters

      • event: "waiting"
      • listener: (data: WaitingEvent) => void

        The callback function

      Returns this

      v0.3.0

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      • event: "paused" | "resumed"
      • listener: (data: Record<string, never>) => void

      Returns this

    • Parameters

      • event: "error"
      • listener: (error: Error, event?: JobEvent) => void

      Returns this

    • Wait until the QueueEvents is ready to receive events. In embedded mode, this resolves immediately. BullMQ v5 compatible.

      Returns Promise<void>