Documentation / @zerotal/queue / index / SyncDriver
Class: SyncDriver
Defined in: queue/src/drivers/SyncDriver.ts:8
Implements
Constructors
Constructor
new SyncDriver():
SyncDriver
Returns
SyncDriver
Properties
_pendingJob
static_pendingJob:Job|undefined=undefined
Defined in: queue/src/drivers/SyncDriver.ts:13
Accessors
failedJobs
Get Signature
get failedJobs():
FailedEntry[]
Defined in: queue/src/drivers/SyncDriver.ts:57
Returns
FailedEntry[]
Methods
push()
push(
record):Promise<void>
Defined in: queue/src/drivers/SyncDriver.ts:15
Parameters
record
Omit<JobRecord, "id" | "createdAt">
Returns
Promise<void>
Implementation of
pop()
pop():
Promise<JobRecord|null>
Defined in: queue/src/drivers/SyncDriver.ts:28
Returns
Promise<JobRecord | null>
Implementation of
fail()
fail(
record,error):Promise<void>
Defined in: queue/src/drivers/SyncDriver.ts:35
Parameters
record
error
string
Returns
Promise<void>
Implementation of
retry()
retry(
record):Promise<void>
Defined in: queue/src/drivers/SyncDriver.ts:39
Parameters
record
Returns
Promise<void>
Implementation of
delete()
delete(
_record):Promise<void>
Defined in: queue/src/drivers/SyncDriver.ts:44
Parameters
_record
Returns
Promise<void>
Implementation of
size()
size():
Promise<number>
Defined in: queue/src/drivers/SyncDriver.ts:48
Returns
Promise<number>
Implementation of
flush()
flush():
Promise<void>
Defined in: queue/src/drivers/SyncDriver.ts:52
Returns
Promise<void>
Implementation of
listFailed()
listFailed(
queue?):Promise<FailedRecord[]>
Defined in: queue/src/drivers/SyncDriver.ts:61
Return all failed jobs, optionally filtered to a single queue.
Parameters
queue?
string
Returns
Promise<FailedRecord[]>
Implementation of
deleteFailedRecord()
deleteFailedRecord(
id):Promise<void>
Defined in: 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: queue/src/drivers/SyncDriver.ts:78
Delete all failed jobs, optionally filtered to a single queue.
Parameters
queue?
string
Returns
Promise<void>