Class RedisQueue

Redis queue (via ioredis).

A reliable, shared queue: ready jobs are ids on a per-queue LIST, delayed jobs on a ZSET (scored by availability), in-flight jobs on a processing LIST, and each job's data under its own key. reserve atomically moves an id to the processing list (RPOPLPUSH), so a crashed worker leaves the job recoverable. ioredis is imported lazily as an optional peer dependency.

Implements

QueueConnection

Index

Constructors

constructor

new RedisQueue(options: RedisConnectionOptions): RedisQueue
Parameters
- options: RedisConnectionOptions
  The connection options.
Returns RedisQueue

Properties

`Readonly`name

name: string

A human-readable connection name (e.g. 'memory', 'redis').

Methods

ack

ack(job: Job): Promise<void>
Parameters
- job: Job
Returns Promise<void>

Inherit Doc

Implementation of QueueConnection.ack

clear

clear(queue?: string): Promise<void>
Parameters
- Optionalqueue: string
Returns Promise<void>

Inherit Doc

Implementation of QueueConnection.clear

dispatch

dispatch<T = unknown>(
    name: string,
    payload: T,
    options?: JobOptions,
): Promise<string>
Type Parameters
- T = unknown
Parameters
- name: string
- payload: T
- options: JobOptions = {}
Returns Promise<string>

Inherit Doc

Implementation of QueueConnection.dispatch

fail

fail(job: Job, _error: Error): Promise<void>
Parameters
- job: Job
- _error: Error
Returns Promise<void>

Inherit Doc

Implementation of QueueConnection.fail

later

later<T = unknown>(
    delay: number,
    name: string,
    payload: T,
    options?: JobOptions,
): Promise<string>
Type Parameters
- T = unknown
Parameters
- delay: number
- name: string
- payload: T
- options: JobOptions = {}
Returns Promise<string>

Inherit Doc

Implementation of QueueConnection.later

release

release(job: Job, delay?: number): Promise<void>
Parameters
- job: Job
- delay: number = 0
Returns Promise<void>

Inherit Doc

Implementation of QueueConnection.release

reserve

reserve(queue?: string): Promise<Job<any>>
Parameters
- queue: string = ...
Returns Promise<Job<any>>

Inherit Doc

Implementation of QueueConnection.reserve

size

size(queue?: string): Promise<number>
Parameters
- Optionalqueue: string
Returns Promise<number>

Inherit Doc

Implementation of QueueConnection.size

`Static`create

create(options: RedisConnectionOptions): RedisQueue
Create a Redis queue.
Parameters
- options: RedisConnectionOptions
  The connection options.
Returns RedisQueue
A new connection.

Class RedisQueue

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RedisQueue

Properties

Readonlyname

Methods

ack

Parameters

Returns Promise<void>

Inherit Doc

clear

Parameters

Returns Promise<void>

Inherit Doc

dispatch

Type Parameters

Parameters

Returns Promise<string>

Inherit Doc

fail

Parameters

Returns Promise<void>

Inherit Doc

later

Type Parameters

Parameters

Returns Promise<string>

Inherit Doc

release

Parameters

Returns Promise<void>

Inherit Doc

reserve

Parameters

Returns Promise<Job<any>>

Inherit Doc

size

Parameters

Returns Promise<number>

Inherit Doc

Staticcreate

Parameters

Returns RedisQueue

Settings

On This Page

`Readonly`name

`Static`create