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

    Class Worker<T, R>

    Worker class for processing jobs

    Type Parameters

    • T = unknown
    • R = unknown

    Hierarchy

    • EventEmitter
      • Worker
    Index
    name: string
    • get closing(): Promise<void> | null

      Promise that resolves when close() finishes (BullMQ v5 compatible)

      Returns Promise<void> | null

    • Parameters

      • jobId: string
      • Optionalreason: string

      Returns boolean

    • Parameters

      • milliseconds: number = 0
      • OptionalabortController: AbortController

      Returns Promise<void>

    • Parameters

      • jobIds: string[]
      • tokens: string[]
      • duration: number

      Returns Promise<number>

    • Parameters

      • Optionaltoken: string
      • Optional_opts: { block?: boolean }

      Returns Promise<Job | undefined>

    • Returns { current: number; duration: number; max: number } | null

    • Alias for emitter.removeListener().

      Parameters

      • event: "drained" | "closed" | "ready"
      • listener: () => void

      Returns this

      v10.0.0

    • Parameters

      • event: "active"
      • listener: (job: Job<T>) => void

      Returns this

    • Parameters

      • event: "completed"
      • listener: (job: Job<T>, result: R) => void

      Returns this

    • Parameters

      • event: "failed"
      • listener: (job: Job<T>, error: Error) => void

      Returns this

    • Parameters

      • event: "progress"
      • listener: (job: Job<T> | null, progress: number) => void

      Returns this

    • Parameters

      • event: "stalled"
      • listener: (jobId: string, reason: string) => void

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • event: "cancelled"
      • listener: (data: { jobId: string; reason: string }) => void

      Returns this

    • Parameters

      • event: "log"
      • listener: (job: Job<T>, message: string) => void

      Returns this

    • 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: "drained" | "closed" | "ready"
      • listener: () => void

        The callback function

      Returns this

      v0.1.101

    • Parameters

      • event: "active"
      • listener: (job: Job<T>) => void

      Returns this

    • Parameters

      • event: "completed"
      • listener: (job: Job<T>, result: R) => void

      Returns this

    • Parameters

      • event: "failed"
      • listener: (job: Job<T>, error: Error) => void

      Returns this

    • Parameters

      • event: "progress"
      • listener: (job: Job<T> | null, progress: number) => void

      Returns this

    • Parameters

      • event: "stalled"
      • listener: (jobId: string, reason: string) => void

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • event: "cancelled"
      • listener: (data: { jobId: string; reason: string }) => void

      Returns this

    • Parameters

      • event: "log"
      • listener: (job: Job<T>, message: string) => 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: "drained" | "closed" | "ready"
      • listener: () => void

        The callback function

      Returns this

      v0.3.0

    • Parameters

      • event: "active"
      • listener: (job: Job<T>) => void

      Returns this

    • Parameters

      • event: "completed"
      • listener: (job: Job<T>, result: R) => void

      Returns this

    • Parameters

      • event: "failed"
      • listener: (job: Job<T>, error: Error) => void

      Returns this

    • Parameters

      • event: "progress"
      • listener: (job: Job<T> | null, progress: number) => void

      Returns this

    • Parameters

      • event: "stalled"
      • listener: (jobId: string, reason: string) => void

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • event: "cancelled"
      • listener: (data: { jobId: string; reason: string }) => void

      Returns this

    • Parameters

      • event: "log"
      • listener: (job: Job<T>, message: string) => void

      Returns this

    • Parameters

      • job: Job
      • Optionaltoken: string
      • OptionalfetchNextCallback: () => Promise<Job | undefined>

      Returns Promise<Job | undefined>