bullmq - v5.64.0
    Preparing search index...

    Interface QueueEventsOptions

    Options for QueueEvents

    interface QueueEventsOptions {
        autorun?: boolean;
        blockingConnection?: boolean;
        blockingTimeout?: number;
        connection: ConnectionOptions;
        lastEventId?: string;
        prefix?: string;
        skipVersionCheck?: boolean;
        skipWaitingForReady?: boolean;
    }

    Hierarchy

    Index

    Properties

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

    Properties

    autorun?: boolean

    Condition to start listening to events at instance creation.

    blockingConnection?: boolean

    Denotes commands should retry indefinitely.

    not in use anymore.

    blockingTimeout?: number

    Timeout for the blocking XREAD call to the events stream.

    connection: ConnectionOptions

    Options for connecting to a Redis instance.

    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.

    prefix?: string

    Prefix for all queue keys.

    skipVersionCheck?: boolean

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

    false
    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.

    Settings

    Member Visibility

    On This Page

    Properties