Class RedisConnection

constructor

• new RedisConnection(opts, extraOptions?): RedisConnection

• Parameters

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

    • Optional blocking?: boolean

    • Optional shared?: boolean

    • Optional skipVersionCheck?: boolean

    • Optional skipWaitingForReady?: boolean

  Returns RedisConnection

capabilities

closing

status

Static minimumVersion

Static recommendedMinimumVersion

client

• get client(): Promise<RedisClient>

• Returns Promise<RedisClient>

redisVersion

• get redisVersion(): string

• Returns string

close

• close(force?): Promise<void>

• Parameters

  • force: boolean = false

  Returns Promise<void>

disconnect

• disconnect(wait?): Promise<void>

• Parameters

  • wait: boolean = true

  Returns Promise<void>

reconnect

• reconnect(): Promise<void>

• Returns Promise<void>

Static waitUntilReady

• waitUntilReady(client): Promise<void>

• Waits for a redis client to be ready.

  Parameters

  • client: RedisClient

  Returns Promise<void>