bullmq - v6.4.0
    Preparing search index...

    Interface RelayOptions<C>

    interface RelayOptions<C = ConnectionOptions> {
        backend?: RelayBackendFactory<C>;
        blockTimeout?: number;
        connection: C;
        heartbeatInterval?: number;
        inboxMaxLength?: number;
        lagThreshold?: number;
        leaseDuration?: number;
        maxMessageSize?: number;
        name?: string;
        namespace?: string;
        nodeId?: string;
        prefix?: string;
        skipVersionCheck?: boolean;
        sweepInterval?: number;
    }

    Type Parameters

    Index
    backend? blockTimeout? connection heartbeatInterval? inboxMaxLength? lagThreshold? leaseDuration? maxMessageSize? name? namespace? nodeId? prefix? skipVersionCheck? sweepInterval?
    backend?: RelayBackendFactory<C>

    Datastore backend. Default: Redis.

    blockTimeout?: number

    Max time an inbox read waits for new messages (ms). Default 5000.

    connection: C

    Connection to the datastore (Redis by default, see backend).

    heartbeatInterval?: number

    Default leaseDuration / 3, rounded down to at least 1 ms.

    inboxMaxLength?: number

    Max number of unread messages kept in this node's inbox. When a slow node falls further behind, its oldest unread messages are dropped. Enforced on publish (Redis) and by safe inbox trimming. Default 10000.

    lagThreshold?: number

    Emit 'lag' when this node has at least this many unread messages, checked after inbox batches are read and on heartbeat. Must not exceed inboxMaxLength. Default inboxMaxLength / 2.

    leaseDuration?: number

    How long this node stays registered without a heartbeat (ms). After that, any node may sweep it with its subscriptions. Default 30000.

    maxMessageSize?: number

    Max serialized message size (bytes). Default 512 KiB.

    name?: string

    Human-readable name of this node (e.g. the service it belongs to), shown by dashboards. Up to 256 characters.

    namespace?: string

    Isolates relays sharing a datastore. Default default.

    nodeId?: string

    Unique id of this node. Default: random.

    prefix?: string

    Key prefix (Redis only). Default bull.

    skipVersionCheck?: boolean
    sweepInterval?: number

    How often this node sweeps expired nodes (ms). Default leaseDuration.

    Settings
    Member Visibility

    On This Page
    Properties