CloudflareObjectJobQueue
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:22
Type Parameters
Section titled “Type Parameters”T
Implements
Section titled “Implements”JobQueue<T>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CloudflareObjectJobQueue<
T>(storage,keyPrefix?):CloudflareObjectJobQueue<T>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:23
Parameters
Section titled “Parameters”storage
Section titled “storage”keyPrefix?
Section titled “keyPrefix?”string = "kmsg/jobs"
Returns
Section titled “Returns”CloudflareObjectJobQueue<T>
Methods
Section titled “Methods”clear()
Section titled “clear()”clear():
Promise<void>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:180
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”complete()
Section titled “complete()”complete(
jobId,_result?):Promise<void>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:87
Parameters
Section titled “Parameters”string
_result?
Section titled “_result?”any
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”dequeue()
Section titled “dequeue()”dequeue():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:60
Returns
Section titled “Returns”Promise<Job<T> | undefined>
Implementation of
Section titled “Implementation of”enqueue()
Section titled “enqueue()”enqueue(
type,data,options?):Promise<Job<T>>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:28
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>>
Implementation of
Section titled “Implementation of”fail()
Section titled “fail()”fail(
jobId,error,shouldRetry?):Promise<void>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:103
Parameters
Section titled “Parameters”string
string | Error
shouldRetry?
Section titled “shouldRetry?”boolean = false
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”getJob()
Section titled “getJob()”getJob(
jobId):Promise<Job<T> |undefined>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:167
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Job<T> | undefined>
Implementation of
Section titled “Implementation of”peek()
Section titled “peek()”peek():
Promise<Job<T> |undefined>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:142
Returns
Section titled “Returns”Promise<Job<T> | undefined>
Implementation of
Section titled “Implementation of”remove()
Section titled “remove()”remove(
jobId):Promise<boolean>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:173
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”size()
Section titled “size()”size():
Promise<number>
Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:157
Returns
Section titled “Returns”Promise<number>