Class Bunqueue<T, R>

Simplified all-in-one Queue and Worker façade.

Type Parameters

T = unknown
R = unknown

Hierarchy

BunqueueRuntime<T, R>
- Bunqueue

Constructors

constructor

new Bunqueue<T = unknown, R = unknown>(
name: string,
options: BunqueueOptions<T, R>,
): Bunqueue<T, R>
Type Parameters
- T = unknown
- R = unknown
Parameters
- name: string
- options: BunqueueOptions<T, R>
Returns Bunqueue<T, R>
Inherited from BunqueueRuntime<T, R>.constructor
- Defined in client/bunqueue/runtime.ts:40

Properties

`Readonly`name

name: string

`Readonly`queue

queue: Queue<T>

`Readonly`worker

worker: Worker<T, R>

Methods

add

add(name: string, data: T, options?: JobOptions): Promise<Job<T>>
Parameters
- name: string
- data: T
- Optionaloptions: JobOptions
Returns Promise<Job<T>>
- Defined in client/bunqueue.ts:27

addBulk

addBulk(jobs: { data: T; name: string; opts?: JobOptions }[]): Promise<Job<T>[]>
Parameters
- jobs: { data: T; name: string; opts?: JobOptions }[]
Returns Promise<Job<T>[]>
- Defined in client/bunqueue.ts:31

cancel

cancel(jobId: string, gracePeriodMs?: number): void
Cancel a running job: at once (the default, 0 or, as on 2.9.10, a negative value or NaN), or after gracePeriodMs (a numeric string is that number). Throws a RangeError for Infinity (2.9.10 cancelled after ~1 ms) and a TypeError for another non-number; any finite grace is honoured, even beyond 24.8 days.
Parameters
- jobId: string
- OptionalgracePeriodMs: number
Returns void
- Defined in client/bunqueue.ts:100

close

close(force?: boolean): Promise<void>
Parameters
- force: boolean = false
Returns Promise<void>
- Defined in client/bunqueue.ts:247

count

count(): number
Returns number
- Defined in client/bunqueue.ts:52

countAsync

countAsync(): Promise<number>
Returns Promise<number>
- Defined in client/bunqueue.ts:56

cron

cron(
    id: string,
    pattern: string,
    data?: T,
    options?: { jobOpts?: JobOptions; limit?: number; timezone?: string },
): Promise<SchedulerInfo | null>
Parameters
- id: string
- pattern: string
- Optionaldata: T
- Optionaloptions: { jobOpts?: JobOptions; limit?: number; timezone?: string }
Returns Promise<SchedulerInfo | null>
- Defined in client/bunqueue.ts:60

every

every(
    id: string,
    intervalMs: number,
    data?: T,
    options?: { jobOpts?: JobOptions; limit?: number },
): Promise<SchedulerInfo | null>
Parameters
- id: string
- intervalMs: number
- Optionaldata: T
- Optionaloptions: { jobOpts?: JobOptions; limit?: number }
Returns Promise<SchedulerInfo | null>
- Defined in client/bunqueue.ts:73

getCircuitState

getCircuitState(): CircuitState
Returns CircuitState
- Defined in client/bunqueue.ts:117

getDlq

getDlq(filter?: DlqFilter): DlqEntry<T>[]
Parameters
- Optionalfilter: DlqFilter
Returns DlqEntry<T>[]
- Defined in client/bunqueue.ts:154

getDlqAsync

getDlqAsync(filter?: DlqFilter): Promise<DlqEntry<T>[]>
Parameters
- Optionalfilter: DlqFilter
Returns Promise<DlqEntry<T>[]>
- Defined in client/bunqueue.ts:158

getDlqConfig

getDlqConfig(): DlqConfig
Returns DlqConfig
- Defined in client/bunqueue.ts:146

getDlqConfigAsync

getDlqConfigAsync(): Promise<DlqConfig>
Returns Promise<DlqConfig>
- Defined in client/bunqueue.ts:150

getDlqStats

getDlqStats(): DlqStats
Returns DlqStats
- Defined in client/bunqueue.ts:162

getDlqStatsAsync

getDlqStatsAsync(): Promise<DlqStats>
Returns Promise<DlqStats>
- Defined in client/bunqueue.ts:166

getJob

getJob(id: string): Promise<Job<T> | null>
Parameters
- id: string
Returns Promise<Job<T> | null>
- Defined in client/bunqueue.ts:40

getJobCounts

getJobCounts(): JobCounts | Promise<JobCounts>
Returns JobCounts | Promise<JobCounts>
- Defined in client/bunqueue.ts:44

getJobCountsAsync

getJobCountsAsync(): Promise<JobCounts>
Returns Promise<JobCounts>
- Defined in client/bunqueue.ts:48

getSignal

getSignal(jobId: string): AbortSignal | null
Parameters
- jobId: string
Returns AbortSignal | null
- Defined in client/bunqueue.ts:113

isCancelled

isCancelled(jobId: string): boolean
Parameters
- jobId: string
Returns boolean
- Defined in client/bunqueue.ts:109

isClosed

isClosed(): boolean
Returns boolean
- Defined in client/bunqueue.ts:264

isPaused

isPaused(): boolean
Returns boolean
- Defined in client/bunqueue.ts:260

isRunning

isRunning(): boolean
Returns boolean
- Defined in client/bunqueue.ts:256

listCrons

listCrons(): Promise<SchedulerInfo[]>
Returns Promise<SchedulerInfo[]>
- Defined in client/bunqueue.ts:90

off

off(event: any, listener: (...args: any[]) => void): this
Parameters
- event: any
- listener: (...args: any[]) => void
Returns this
- Defined in client/bunqueue.ts:222

on

on(event: "drained" | "ready" | "closed", listener: () => void): this
Parameters
- event: "drained" | "ready" | "closed"
- listener: () => void
Returns this
- Defined in client/bunqueue.ts:202
on(event: "active", listener: (job: Job<T>) => void): this
Parameters
- event: "active"
- listener: (job: Job<T>) => void
Returns this
- Defined in client/bunqueue.ts:203
on(event: "completed", listener: (job: Job<T>, result: R) => void): this
Parameters
- event: "completed"
- listener: (job: Job<T>, result: R) => void
Returns this
- Defined in client/bunqueue.ts:204
on(event: "failed", listener: (job: Job<T>, error: Error) => void): this
Parameters
- event: "failed"
- listener: (job: Job<T>, error: Error) => void
Returns this
- Defined in client/bunqueue.ts:205
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
- Defined in client/bunqueue.ts:206
on(event: "stalled", listener: (jobId: string, reason: string) => void): this
Parameters
- event: "stalled"
- listener: (jobId: string, reason: string) => void
Returns this
- Defined in client/bunqueue.ts:207
on(event: "error", listener: (error: Error) => void): this
Parameters
- event: "error"
- listener: (error: Error) => void
Returns this
- Defined in client/bunqueue.ts:208

once

once(event: "drained" | "ready" | "closed", listener: () => void): this
Parameters
- event: "drained" | "ready" | "closed"
- listener: () => void
Returns this
- Defined in client/bunqueue.ts:214
once(event: "completed", listener: (job: Job<T>, result: R) => void): this
Parameters
- event: "completed"
- listener: (job: Job<T>, result: R) => void
Returns this
- Defined in client/bunqueue.ts:215
once(event: "failed", listener: (job: Job<T>, error: Error) => void): this
Parameters
- event: "failed"
- listener: (job: Job<T>, error: Error) => void
Returns this
- Defined in client/bunqueue.ts:216

pause

pause(): void
Returns void
- Defined in client/bunqueue.ts:227

pauseAsync

pauseAsync(): Promise<void>
Returns Promise<void>
- Defined in client/bunqueue.ts:237

purgeDlq

purgeDlq(): number
Returns number
- Defined in client/bunqueue.ts:178

purgeDlqAsync

purgeDlqAsync(): Promise<number>
Returns Promise<number>
- Defined in client/bunqueue.ts:182

removeCron

removeCron(id: string): Promise<boolean>
Parameters
- id: string
Returns Promise<boolean>
- Defined in client/bunqueue.ts:86

removeGlobalRateLimit

removeGlobalRateLimit(): void
Returns void
- Defined in client/bunqueue.ts:194

removeGlobalRateLimitAsync

removeGlobalRateLimitAsync(): Promise<void>
Returns Promise<void>
- Defined in client/bunqueue.ts:198

resetCircuit

resetCircuit(): void
Returns void
- Defined in client/bunqueue.ts:121

resume

resume(): void
Returns void
- Defined in client/bunqueue.ts:232

resumeAsync

resumeAsync(): Promise<void>
Returns Promise<void>
- Defined in client/bunqueue.ts:242

retryDlq

retryDlq(id?: string): number
Parameters
- Optionalid: string
Returns number
- Defined in client/bunqueue.ts:170

retryDlqAsync

retryDlqAsync(id?: string): Promise<number>
Parameters
- Optionalid: string
Returns Promise<number>
- Defined in client/bunqueue.ts:174

setDefaultTtl

setDefaultTtl(ttlMs: number): void
Parameters
- ttlMs: number
Returns void
- Defined in client/bunqueue.ts:130

setDlqConfig

setDlqConfig(config: Partial<DlqConfig>): void
Parameters
- config: Partial<DlqConfig>
Returns void
- Defined in client/bunqueue.ts:138

setDlqConfigAsync

setDlqConfigAsync(config: Partial<DlqConfig>): Promise<void>
Parameters
- config: Partial<DlqConfig>
Returns Promise<void>
- Defined in client/bunqueue.ts:142

setGlobalRateLimit

setGlobalRateLimit(max: number, duration?: number): void
Parameters
- max: number
- Optionalduration: number
Returns void
- Defined in client/bunqueue.ts:186

setGlobalRateLimitAsync

setGlobalRateLimitAsync(max: number, duration?: number): Promise<void>
Parameters
- max: number
- Optionalduration: number
Returns Promise<void>
- Defined in client/bunqueue.ts:190

setNameTtl

setNameTtl(name: string, ttlMs: number): void
Parameters
- name: string
- ttlMs: number
Returns void
- Defined in client/bunqueue.ts:134

trigger

trigger(rule: TriggerRule<T>): this
Parameters
- rule: TriggerRule<T>
Returns this
- Defined in client/bunqueue.ts:125

use

use(middleware: BunqueueMiddleware<T, R>): this
Parameters
- middleware: BunqueueMiddleware<T, R>
Returns this
Inherited from BunqueueRuntime.use
- Defined in client/bunqueue/runtime.ts:195

Class Bunqueue<T, R>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Bunqueue<T, R>

Properties

Readonlyname

Readonlyqueue

Readonlyworker

Methods

add

Parameters

Returns Promise<Job<T>>

addBulk

Parameters

Returns Promise<Job<T>[]>

cancel

Parameters

Returns void

close

Parameters

Returns Promise<void>

count

Returns number

countAsync

Returns Promise<number>

cron

Parameters

Returns Promise<SchedulerInfo | null>

every

Parameters

Returns Promise<SchedulerInfo | null>

getCircuitState

Returns CircuitState

getDlq

Parameters

Returns DlqEntry<T>[]

getDlqAsync

Parameters

Returns Promise<DlqEntry<T>[]>

getDlqConfig

Returns DlqConfig

getDlqConfigAsync

Returns Promise<DlqConfig>

getDlqStats

Returns DlqStats

getDlqStatsAsync

Returns Promise<DlqStats>

getJob

Parameters

Returns Promise<Job<T> | null>

getJobCounts

Returns JobCounts | Promise<JobCounts>

getJobCountsAsync

Returns Promise<JobCounts>

getSignal

Parameters

Returns AbortSignal | null

isCancelled

Parameters

Returns boolean

isClosed

Returns boolean

isPaused

Returns boolean

isRunning

Returns boolean

listCrons

Returns Promise<SchedulerInfo[]>

off

Parameters

Returns this

on

`Readonly`name

`Readonly`queue

`Readonly`worker