Documentation / zerotal / queue / QueueDriver

Interface: QueueDriver

Defined in: packages/queue/src/drivers/QueueDriver.ts:32

Methods

push()

push(record): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:34

Parameters

record

Omit<JobRecord, "id" | "createdAt">

Returns

Promise<void>

pop()

pop(queue?): Promise<JobRecord | null>

Defined in: packages/queue/src/drivers/QueueDriver.ts:35

Parameters

queue?

string

Returns

Promise<JobRecord | null>

fail()

fail(record, error): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:36

Parameters

record

JobRecord

error

string

Returns

Promise<void>

retry()

retry(record): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:37

Parameters

record

JobRecord

Returns

Promise<void>

delete()

delete(record): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:38

Parameters

record

JobRecord

Returns

Promise<void>

size()

size(queue?): Promise<number>

Defined in: packages/queue/src/drivers/QueueDriver.ts:39

Parameters

queue?

string

Returns

Promise<number>

flush()

flush(): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:40

Returns

Promise<void>

listPending()?

optional listPending(queue?, limit?, offset?): Promise<JobRecord[]>

Defined in: packages/queue/src/drivers/QueueDriver.ts:44

List pending jobs (paged), optionally filtered to a single queue.

Parameters

queue?

string

limit?

number

offset?

number

Returns

Promise<JobRecord[]>

queues()?

optional queues(): Promise<object[]>

Defined in: packages/queue/src/drivers/QueueDriver.ts:46

Distinct queue names with their pending depth.

Returns

Promise<object[]>

listFailed()

listFailed(queue?): Promise<FailedRecord[]>

Defined in: packages/queue/src/drivers/QueueDriver.ts:50

Return all failed jobs, optionally filtered to a single queue.

Parameters

queue?

string

Returns

Promise<FailedRecord[]>

deleteFailedRecord()

deleteFailedRecord(id): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:52

Remove a single failed job by its ID.

Parameters

id

number

Returns

Promise<void>

clearFailed()

clearFailed(queue?): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:54

Delete all failed jobs, optionally filtered to a single queue.

Parameters

queue?

string

Returns

Promise<void>

createBatch()?

optional createBatch(id, name, totalJobs, optionsJson): Promise<void>

Defined in: packages/queue/src/drivers/QueueDriver.ts:58

Create a new batch row and return immediately.

Parameters

id

string

name

string

totalJobs

number

optionsJson

string

Returns

Promise<void>

recordBatchJobComplete()?

optional recordBatchJobComplete(batchId): Promise<BatchStatus>

Defined in: packages/queue/src/drivers/QueueDriver.ts:60

Decrement pending_jobs for a completed job; mark finished if last.

Parameters

batchId

string

Returns

Promise<BatchStatus>

recordBatchJobFailed()?

optional recordBatchJobFailed(batchId, jobId): Promise<BatchStatus>

Defined in: packages/queue/src/drivers/QueueDriver.ts:62

Decrement pending_jobs + increment failed_jobs; mark finished if last.

Parameters

batchId

string

jobId

number

Returns

Promise<BatchStatus>

getBatch()?

optional getBatch(batchId): Promise<BatchRecord | null>

Defined in: packages/queue/src/drivers/QueueDriver.ts:64

Look up a batch row by ID.

Parameters

batchId

string

Returns

Promise<BatchRecord | null>