Interface QueueEventsOptions

Options for QueueEvents

Hierarchy

  • QueueBaseOptions
    • QueueEventsOptions

Properties

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

Properties

Optional autorun

autorun?: boolean

Condition to start listening to events at instance creation.

Optional blockingConnection

blockingConnection?: boolean

Denotes commands should retry indefinitely.

Optional blockingTimeout

blockingTimeout?: number

Timeout for the blocking XREAD call to the events stream.

Optional 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc