JobQueue
Defined in: packages/messaging/src/queue/job-queue.interface.ts:26
Type Parameters
Section titled “Type Parameters”T
Methods
Section titled “Methods”clear()
Section titled “clear()”clear():
Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:56
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:40
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:38
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:27
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,shouldRetry?):Promise<void>
Defined in: packages/messaging/src/queue/job-queue.interface.ts:42
Parameters
Section titled “Parameters”string
string | Error
shouldRetry?
Section titled “shouldRetry?”boolean
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:52
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:48
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:54
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:50
Returns
Section titled “Returns”Promise<number>