Documentation / @zerotal/queue / index / RedisDriver
Class: RedisDriver
Defined in: queue/src/drivers/RedisDriver.ts:48
Implements
Constructors
Constructor
new RedisDriver(
prefix?,options?):RedisDriver
Defined in: queue/src/drivers/RedisDriver.ts:59
Parameters
prefix?
string = "zerotal:jobs:"
Key prefix for every key family this driver owns.
options?
visibilityTimeout?
number
Seconds a claimed job stays invisible before being
reclaimed. Defaults to 90, matching SqliteDriver.
client?
RedisClientLike
Redis client to use. Defaults to Bun's built-in redis.
Returns
RedisDriver
Methods
push()
push(
record):Promise<void>
Defined in: queue/src/drivers/RedisDriver.ts:99
Parameters
record
Omit<JobRecord, "id" | "createdAt">
Returns
Promise<void>
Implementation of
pop()
pop(
queue?):Promise<JobRecord|null>
Defined in: queue/src/drivers/RedisDriver.ts:155
Parameters
queue?
string = "default"
Returns
Promise<JobRecord | null>
Implementation of
fail()
fail(
record,error):Promise<void>
Defined in: queue/src/drivers/RedisDriver.ts:197
Parameters
record
error
string
Returns
Promise<void>
Implementation of
retry()
retry(
record):Promise<void>
Defined in: queue/src/drivers/RedisDriver.ts:206
Parameters
record
Returns
Promise<void>
Implementation of
delete()
delete(
record):Promise<void>
Defined in: queue/src/drivers/RedisDriver.ts:218
Parameters
record
Returns
Promise<void>
Implementation of
size()
size(
queue?):Promise<number>
Defined in: queue/src/drivers/RedisDriver.ts:223
Parameters
queue?
string = "default"
Returns
Promise<number>
Implementation of
flush()
flush():
Promise<void>
Defined in: queue/src/drivers/RedisDriver.ts:232
Returns
Promise<void>
Implementation of
listFailed()
listFailed(
queue?):Promise<FailedRecord[]>
Defined in: queue/src/drivers/RedisDriver.ts:253
Return all failed jobs, optionally filtered to a single queue.
Parameters
queue?
string
Returns
Promise<FailedRecord[]>
Implementation of
deleteFailedRecord()
deleteFailedRecord(
id,queue?):Promise<void>
Defined in: queue/src/drivers/RedisDriver.ts:278
Remove a single failed job by its ID.
Parameters
id
number
queue?
string
Returns
Promise<void>
Implementation of
QueueDriver.deleteFailedRecord
clearFailed()
clearFailed(
queue?):Promise<void>
Defined in: queue/src/drivers/RedisDriver.ts:296
Delete all failed jobs, optionally filtered to a single queue.
Parameters
queue?
string
Returns
Promise<void>