Class Bunqueue<T, R>

constructor

• new Bunqueue<T = unknown, R = unknown>(
      name: string,
      opts: BunqueueOptions<T, R>,
  ): Bunqueue<T, R>

  Type Parameters

  • T = unknown
  • R = unknown

  Parameters

  • name: string
  • opts: BunqueueOptions<T, R>

  Returns Bunqueue<T, R>

Readonlyname

Readonlyqueue

Readonlyworker

add

• add(name: string, data: T, opts?: JobOptions): Promise<Job<T>>

  Parameters

  • name: string
  • data: T
  • Optionalopts: JobOptions

  Returns Promise<Job<T>>

addBulk

• addBulk(jobs: { data: T; name: string; opts?: JobOptions }[]): Promise<Job<T>[]>

  Parameters

  • jobs: { data: T; name: string; opts?: JobOptions }[]

  Returns Promise<Job<T>[]>

cancel

• cancel(jobId: string, gracePeriodMs?: number): void

  Parameters

  • jobId: string
  • gracePeriodMs: number = 0

  Returns void

close

• close(force?: boolean): Promise<void>

  Parameters

  • force: boolean = false

  Returns Promise<void>

count

• count(): number

  Returns number

countAsync

• countAsync(): Promise<number>

  Returns Promise<number>

cron

• cron(
      id: string,
      pattern: string,
      data?: T,
      opts?: { jobOpts?: JobOptions; limit?: number; timezone?: string },
  ): Promise<SchedulerInfo | null>

  Parameters

  • id: string
  • pattern: string
  • Optionaldata: T
  • Optionalopts: { jobOpts?: JobOptions; limit?: number; timezone?: string }

  Returns Promise<SchedulerInfo | null>

every

• every(
      id: string,
      intervalMs: number,
      data?: T,
      opts?: { jobOpts?: JobOptions; limit?: number },
  ): Promise<SchedulerInfo | null>

  Parameters

  • id: string
  • intervalMs: number
  • Optionaldata: T
  • Optionalopts: { jobOpts?: JobOptions; limit?: number }

  Returns Promise<SchedulerInfo | null>

getCircuitState

• getCircuitState(): CircuitState

  Returns CircuitState

getDlq

• getDlq(filter?: DlqFilter): DlqEntry<T>[]

  Parameters

  • Optionalfilter: DlqFilter

  Returns DlqEntry<T>[]

getDlqConfig

• getDlqConfig(): DlqConfig

  Returns DlqConfig

getDlqStats

• getDlqStats(): DlqStats

  Returns DlqStats

getJob

• getJob(id: string): Promise<Job<T> | null>

  Parameters

  • id: string

  Returns Promise<Job<T> | null>

getJobCounts

• getJobCounts(): JobCounts | Promise<JobCounts>

  Returns JobCounts | Promise<JobCounts>

getJobCountsAsync

• getJobCountsAsync(): Promise<JobCounts>

  Returns Promise<JobCounts>

getSignal

• getSignal(jobId: string): AbortSignal | null

  Parameters

  • jobId: string

  Returns AbortSignal | null

isCancelled

• isCancelled(jobId: string): boolean

  Parameters

  • jobId: string

  Returns boolean

isClosed

• isClosed(): boolean

  Returns boolean

isPaused

• isPaused(): boolean

  Returns boolean

isRunning

• isRunning(): boolean

  Returns boolean

listCrons

• listCrons(): Promise<SchedulerInfo[]>

  Returns Promise<SchedulerInfo[]>

off

• off(event: any, listener: (...args: any[]) => void): this

  Parameters

  • event: any
  • listener: (...args: any[]) => void

  Returns this

on

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

once

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

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

  Parameters

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

  Returns this

pause

• pause(): void

  Returns void

purgeDlq

• purgeDlq(): number

  Returns number

removeCron

• removeCron(id: string): Promise<boolean>

  Parameters

  • id: string

  Returns Promise<boolean>

removeGlobalRateLimit

• removeGlobalRateLimit(): void

  Returns void

resetCircuit

• resetCircuit(): void

  Returns void

resume

• resume(): void

  Returns void

retryDlq

• retryDlq(id?: string): number

  Parameters

  • Optionalid: string

  Returns number

setDefaultTtl

• setDefaultTtl(ttlMs: number): void

  Parameters

  • ttlMs: number

  Returns void

setDlqConfig

• setDlqConfig(config: Partial<DlqConfig>): void

  Parameters

  • config: Partial<DlqConfig>

  Returns void

setGlobalRateLimit

• setGlobalRateLimit(max: number, duration?: number): void

  Parameters

  • max: number
  • Optionalduration: number

  Returns void

setNameTtl

• setNameTtl(name: string, ttlMs: number): void

  Parameters

  • name: string
  • ttlMs: number

  Returns void

trigger

• trigger(rule: TriggerRule<T>): this

  Parameters

  • rule: TriggerRule<T>

  Returns this

use

• use(middleware: BunqueueMiddleware<T, R>): this

  Parameters

  • middleware: BunqueueMiddleware<T, R>

  Returns this