JobQueue
Defined in: packages/messaging/src/queue/job-queue.interface.ts:31
Type Parameters
Section titled “Type Parameters”T
Methods
Section titled “Methods”cleanupTerminal()?
Section titled “cleanupTerminal()?”
optionalcleanupTerminal(statuses?):Promise<number>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:63
Parameters
Section titled “Parameters”statuses?
Section titled “statuses?”Returns
Section titled “Returns”Promise<number>
clear()
Section titled “clear()”clear():
Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:61
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:45
Parameters
Section titled “Parameters”string
result?
Section titled “result?”any
Returns
Section titled “Returns”Promise<void>
dequeue()
Section titled “dequeue()”dequeue():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:43
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:32
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:47
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:57
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Job<T> | undefined>
peek()
Section titled “peek()”peek():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:53
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:59
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:55
Returns
Section titled “Returns”Promise<number>