bullmq - v5.77.1
    Preparing search index...

    Class RedisConnection

    Hierarchy

    • EventEmitter
      • RedisConnection
    Index

    Constructors

    constructor

    Properties

    capabilities closing status clientFactory? minimumVersion recommendedMinimumVersion

    Accessors

    client databaseType redisVersion

    Methods

    close disconnect reconnect waitUntilReady

    Constructors

    • Parameters

      • opts: ConnectionOptions
      • OptionalextraOptions: {
            blocking?: boolean;
            shared?: boolean;
            skipVersionCheck?: boolean;
            skipWaitingForReady?: boolean;
        }

      Returns RedisConnection

    Properties

    capabilities: RedisCapabilities = ...
    closing: boolean
    status: "closed" | "ready" | "closing" | "initializing" = 'initializing'
    clientFactory?: (opts: RedisOptions) => IRedisClient

    Optional factory that creates an IRedisClient from raw options.

    When set, RedisConnection will call this factory instead of creating an ioredis client internally. This allows swapping the Redis driver (e.g. node-redis, Bun built-in) without changing consumer code.

    The factory receives the merged RedisOptions and must return an already-augmented IRedisClient (e.g. via createNodeRedisClient).

    import { createClient } from 'redis';
    import { RedisConnection, createNodeRedisClient } from 'bullmq';

    RedisConnection.clientFactory = (opts) => {
      const raw = createClient({ url: `redis://${opts.host ?? '127.0.0.1'}:${opts.port ?? 6379}` });
      return createNodeRedisClient(raw);
    };
    minimumVersion: string = '5.0.0'
    recommendedMinimumVersion: string = '6.2.0'

    Accessors

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods