Interface QueueEventsOptions

Options for QueueEvents

interface QueueEventsOptions {
    autorun?: boolean;
    blockingConnection?: boolean;
    blockingTimeout?: number;
    connection: ConnectionOptions;
    lastEventId?: string;
    prefix?: string;
    skipVersionCheck?: boolean;
    skipWaitingForReady?: boolean;
    telemetry?: Telemetry<any>;
}

Hierarchy (view full)

Properties

autorun? blockingConnection? blockingTimeout? connection lastEventId? prefix? skipVersionCheck? skipWaitingForReady? telemetry?

Properties

Optional autorun

autorun?: boolean

Condition to start listening to events at instance creation.

Optional blockingConnection

blockingConnection?: boolean

Denotes commands should retry indefinitely.

Deprecated

Optional blockingTimeout

blockingTimeout?: number

Timeout for the blocking XREAD call to the events stream.

connection

connection: ConnectionOptions

Options for connecting to a Redis instance.

Optional lastEventId

lastEventId?: string

Last event Id. If provided it is possible to continue consuming events from a known Id instead of from the last produced event.

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