Documentation / zerotal / queue / SyncDriver

Class: SyncDriver

Defined in: packages/queue/src/drivers/SyncDriver.ts:8

Implements

QueueDriver

Constructors

Constructor

new SyncDriver(): SyncDriver

Returns

SyncDriver

Properties

_pendingJob

static _pendingJob: Job | undefined = undefined

Defined in: packages/queue/src/drivers/SyncDriver.ts:13

Accessors

failedJobs

Get Signature

get failedJobs(): FailedEntry[]

Defined in: packages/queue/src/drivers/SyncDriver.ts:57

Returns

FailedEntry[]

Methods

push()

push(record): Promise<void>

Defined in: packages/queue/src/drivers/SyncDriver.ts:15

Parameters

record

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

Returns

Promise<void>

Implementation of

QueueDriver.push

pop()

pop(): Promise<JobRecord | null>

Defined in: packages/queue/src/drivers/SyncDriver.ts:28

Returns

Promise<JobRecord | null>

Implementation of

QueueDriver.pop

fail()

fail(record, error): Promise<void>

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

Parameters

record

JobRecord

error

string

Returns

Promise<void>

Implementation of

QueueDriver.fail

retry()

retry(record): Promise<void>

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

Parameters

record

JobRecord

Returns

Promise<void>

Implementation of

QueueDriver.retry

delete()

delete(_record): Promise<void>

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

Parameters

_record

JobRecord

Returns

Promise<void>

Implementation of

QueueDriver.delete

size()

size(): Promise<number>

Defined in: packages/queue/src/drivers/SyncDriver.ts:48

Returns

Promise<number>

Implementation of

QueueDriver.size

flush()

flush(): Promise<void>

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

Returns

Promise<void>

Implementation of

QueueDriver.flush

listFailed()

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

Defined in: packages/queue/src/drivers/SyncDriver.ts:61

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

Parameters

queue?

string

Returns

Promise<FailedRecord[]>

Implementation of

QueueDriver.listFailed

deleteFailedRecord()

deleteFailedRecord(id): Promise<void>

Defined in: packages/queue/src/drivers/SyncDriver.ts:74

Remove a single failed job by its ID.

Parameters

id

number

Returns

Promise<void>

Implementation of

QueueDriver.deleteFailedRecord

clearFailed()

clearFailed(queue?): Promise<void>

Defined in: packages/queue/src/drivers/SyncDriver.ts:78

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

Parameters

queue?

string

Returns

Promise<void>

Implementation of

QueueDriver.clearFailed