JobQueue
Defined in: packages/messaging/src/queue/job-queue.interface.ts:85
Type Parameters
Section titled “Type Parameters”T
Methods
Section titled “Methods”cleanupTerminal()?
Section titled “cleanupTerminal()?”
optionalcleanupTerminal(options?):Promise<number>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:130
Removes finished jobs: completed and failed ones by default, or those
with the given statuses, and with olderThan, only those that finished
before it.
Parameters
Section titled “Parameters”options?
Section titled “options?”JobQueueCleanupOptions | JobStatus[]
Returns
Section titled “Returns”Promise<number>
clear()
Section titled “clear()”clear():
Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:115
Returns
Section titled “Returns”Promise<void>
complete()
Section titled “complete()”complete(
jobId,result?):Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:99
Parameters
Section titled “Parameters”string
result?
Section titled “result?”any
Returns
Section titled “Returns”Promise<void>
dequeue()
Section titled “dequeue()”dequeue(
options?):Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:97
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Job<T> | undefined>
enqueue()
Section titled “enqueue()”enqueue(
type,data,options?):Promise<Job<T>>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:86
Parameters
Section titled “Parameters”string
T
options?
Section titled “options?”delay?
Section titled “delay?”number
maxAttempts?
Section titled “maxAttempts?”number
metadata?
Section titled “metadata?”Record<string, any>
priority?
Section titled “priority?”number
Returns
Section titled “Returns”Promise<Job<T>>
fail()
Section titled “fail()”fail(
jobId,error,retry?):Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:101
Parameters
Section titled “Parameters”string
string | Error
retry?
Section titled “retry?”Returns
Section titled “Returns”Promise<void>
getJob()
Section titled “getJob()”getJob(
jobId):Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:111
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Job<T> | undefined>
nextDueAt()?
Section titled “nextDueAt()?”
optionalnextDueAt():Promise<Date|undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:123
When dequeue() next has work: the earliest due time of a pending job
or, with leases, lease expiry of a processing one. A time in the past
means dequeue() has work now, even when it only settles an expired
lease. undefined when no job is pending or leased.
Returns
Section titled “Returns”Promise<Date | undefined>
peek()
Section titled “peek()”peek():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:107
Returns
Section titled “Returns”Promise<Job<T> | undefined>
remove()
Section titled “remove()”remove(
jobId):Promise<boolean>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:113
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
size()
Section titled “size()”size():
Promise<number>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:109
Returns
Section titled “Returns”Promise<number>