SQLiteJobQueue

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:51

A job queue in a SQLite database.

With leaseMs, a processing job’s process_at holds its lease’s end, so the table needs no new column. A job already processing without a lease, taken by an earlier version or by a queue without leaseMs, cannot be told from one whose lease has expired, so it is due at once.

Type Parameters

T

T

Implements

JobQueue<T>

Constructors

Constructor

new SQLiteJobQueue<T>(options?): SQLiteJobQueue<T>

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:56

Parameters

options?

SQLiteJobQueueOptions<T> = {}

Returns

SQLiteJobQueue<T>

Methods

cleanupTerminal()

cleanupTerminal(options?): Promise<number>

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:435

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/queue/sqlite-job-queue.ts:426

Returns

Promise<void>

Implementation of

JobQueue.clear

close()

close(): void

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:466

Returns

void

complete()

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

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:277

Parameters

jobId

string

_result?

any

Returns

Promise<void>

Implementation of

JobQueue.complete

dequeue()

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

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:212

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.

Parameters

options?

JobDequeueOptions = {}

Returns

Promise<Job<T> | undefined>

Implementation of

JobQueue.dequeue

enqueue()

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

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:155

Parameters

type

string

data

T

options?

delay?

number

maxAttempts?

number

metadata?

Record<string, any>

priority?

number

Returns

Promise<Job<T>>

Implementation of

JobQueue.enqueue

fail()

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

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:294

Counts a failed attempt: the job is due again after retry.delayMs when retries are enabled and attempts are left, and fails otherwise. 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<Job<T> | undefined>

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:396

Parameters

jobId

string

Returns

Promise<Job<T> | undefined>

Implementation of

JobQueue.getJob

nextDueAt()

nextDueAt(): Promise<Date | undefined>

Defined in: packages/messaging/src/queue/sqlite-job-queue.ts:380

When dequeue() next has work: the earliest due time of a pending job or, with leaseMs, lease expiry of a processing one. 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.