Interface RedisSocketCommonOptions

Hierarchy

  • RedisSocketCommonOptions

Properties

connectTimeout?: number

Connection Timeout (in milliseconds)

keepAlive?: number | false

Toggle keep-alive

noDelay?: boolean
reconnectStrategy?: number | false | ((retries, cause) => number | false | Error)

When the socket closes unexpectedly (without calling .quit()/.disconnect()), the client uses reconnectStrategy to decide what to do. The following values are supported:

  1. false -> do not reconnect, close the client and flush the command queue.
  2. number -> wait for X milliseconds before reconnecting.
  3. (retries: number, cause: Error) => false | number | Error -> number is the same as configuring a number directly, Error is the same as false, but with a custom error. Defaults to retries => Math.min(retries * 50, 500)

Type declaration

    • (retries, cause): number | false | Error
    • Parameters

      • retries: number
      • cause: Error

      Returns number | false | Error

Generated using TypeDoc