Class RedisConnection

constructor

• new RedisConnection(
      opts: ConnectionOptions,
      extraOptions?: {
          blocking?: boolean;
          clusterReconnectTimeoutMs?: number;
          shared?: boolean;
          skipVersionCheck?: boolean;
          skipWaitingForReady?: boolean;
      },
  ): RedisConnection

  Parameters

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

  Returns RedisConnection

capabilities

closing

status

Static OptionalclientFactory

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);
};
Copy

StaticminimumVersion

StaticrecommendedMinimumVersion

client

• get client(): Promise<IRedisClient>

  Returns Promise<IRedisClient>

databaseType

• get databaseType(): DatabaseType

  Returns DatabaseType

redisVersion

• get redisVersion(): string

  Returns string

close

• close(force?: boolean): Promise<void>

  Parameters

  • force: boolean = false

  Returns Promise<void>

disconnect

• disconnect(wait?: boolean): Promise<void>

  Parameters

  • wait: boolean = true

  Returns Promise<void>

reconnect

• reconnect(): Promise<void>

  Returns Promise<void>

runWithClusterRecovery

• runWithClusterRecovery<T>(command: () => Promise<T>): Promise<T>

  Runs a command of a blocking connection with the recovery that bzpopmin gets on an ioredis Cluster: an empty node pool is reconnected before the command, and a cluster left unusable by its failure is reconnected before rethrowing it. Other connections just run the command.

  Type Parameters

  • T

  Parameters

  • command: () => Promise<T>

  Returns Promise<T>

StaticwaitUntilReady

• waitUntilReady(client: IRedisClient): Promise<void>

  Waits for a redis client to be ready.

  Parameters

  • client: IRedisClient

    Redis client to wait for.

  Returns Promise<void>