CloudflareObjectJobQueue

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:76

Type Parameters

T

T

Implements

JobQueue<T>

Constructors

Constructor

new CloudflareObjectJobQueue<T>(storage, options?): CloudflareObjectJobQueue<T>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:82

options may also be the key prefix.

Parameters

storage

CloudflareObjectStorage

options?

string | CloudflareObjectJobQueueOptions<T>

Returns

CloudflareObjectJobQueue<T>

Methods

cleanupTerminal()

cleanupTerminal(options?): Promise<number>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:346

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

options?

JobQueueCleanupOptions | JobStatus[]

Returns

Promise<number>

Implementation of

JobQueue.cleanupTerminal

clear()

clear(): Promise<void>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:334

Returns

Promise<void>

Implementation of

JobQueue.clear

complete()

complete(jobId, result?): Promise<void>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:210

Marks the job completed and keeps result with it when it can be stored as JSON. A result that cannot be stored is logged and dropped, never failing the completion, since callers such as JobProcessor would treat that as a failed job and run it again.

Parameters

jobId

string

result?

unknown

Returns

Promise<void>

Implementation of

JobQueue.complete

dequeue()

dequeue(options?): Promise<CloudflareObjectJob<T> | undefined>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:127

Takes the next due job and, with leaseMs, leases it. Jobs whose lease expired are due again first, or fail when they have no attempts left. Jobs in options.running are left as they are.

Parameters

options?

JobDequeueOptions = {}

Returns

Promise<CloudflareObjectJob<T> | undefined>

Implementation of

JobQueue.dequeue

enqueue()

enqueue(type, data, options?): Promise<CloudflareObjectJob<T>>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:93

Parameters

type

string

data

T

options?

delay?

number

maxAttempts?

number

metadata?

Record<string, any>

priority?

number

Returns

Promise<CloudflareObjectJob<T>>

Implementation of

JobQueue.enqueue

fail()

fail(jobId, error, retry?): Promise<void>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:237

A completed job stays completed, even for a worker whose lease expired.

Parameters

jobId

string

error

string | Error

retry?

JobRetryDirective = ...

Returns

Promise<void>

Implementation of

JobQueue.fail

getJob()

getJob(jobId): Promise<CloudflareObjectJob<T> | undefined>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:321

Parameters

jobId

string

Returns

Promise<CloudflareObjectJob<T> | undefined>

Implementation of

JobQueue.getJob

nextDueAt()

nextDueAt(): Promise<Date | undefined>

Defined in: packages/messaging/src/adapters/cloudflare/object-job-queue.ts:305

When dequeue() next has work: the earliest due time of a pending job or lease expiry of a processing one, and now for a processing job that has no lease yet. A time in the past means dequeue() has work now, even when it only settles an expired lease, so call dequeue() rather than checking size(). undefined when no job is pending or leased. Use it to set a Durable Object alarm instead of polling.