Class RedisConnection

constructor

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

  Parameters

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

  Returns RedisConnection

capabilities

closing

status

StaticminimumVersion

StaticrecommendedMinimumVersion

client

• get client(): Promise<RedisClient>

  Returns Promise<RedisClient>

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>

StaticwaitUntilReady

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

  Waits for a redis client to be ready.

  Parameters

  • client: RedisClient

  Returns Promise<void>