Interface QueueBaseOptions

Base Queue options

interface QueueBaseOptions {
    blockingConnection?: boolean;
    connection: ConnectionOptions;
    prefix?: string;
    skipVersionCheck?: boolean;
    skipWaitingForReady?: boolean;
    telemetry?: Telemetry<any>;
}

Hierarchy (view full)

Properties

blockingConnection? connection prefix? skipVersionCheck? skipWaitingForReady? telemetry?

Properties

Optional blockingConnection

blockingConnection?: boolean

Denotes commands should retry indefinitely.

Deprecated

not in use anymore.

connection

connection: ConnectionOptions

Options for connecting to a Redis instance.

Optional prefix

prefix?: string

Prefix for all queue keys.

Optional skipVersionCheck

skipVersionCheck?: boolean

Avoid version validation to be greater or equal than v5.0.0.

Default Value

false

Optional skipWaitingForReady

skipWaitingForReady?: boolean

Skip waiting for connection ready.

In some instances if you want the queue to fail fast if the connection is not ready you can set this to true. This could be useful for testing and when adding jobs via HTTP endpoints for example.

Optional telemetry

telemetry?: Telemetry<any>

Telemetry client

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc