Interface IIORedisConfig

Description

Configuration interface for IORedis connector.

interface IIORedisConfig {
    host: string;
    name: string;
    options: SentinelConnectionOptions & {
        failoverDetector?: boolean;
        gracefulDegradation?: boolean;
        lazyConnect?: boolean;
        reconnectTimeoutDelta?: number;
        reconnectTimeoutLimit?: number;
        reconnectTimes?: number;
    };
}

Hierarchy

  • IConnectorConfig
    • IIORedisConfig

Properties

host name options

Properties

host

host: string

name

name: string

options

options: SentinelConnectionOptions & {
    failoverDetector?: boolean;
    gracefulDegradation?: boolean;
    lazyConnect?: boolean;
    reconnectTimeoutDelta?: number;
    reconnectTimeoutLimit?: number;
    reconnectTimes?: number;
}

Type declaration

  • Optional failoverDetector?: boolean

    Description

    Enable Sentinel failover detection via subscribing to Sentinel PubSub events

    Default

    true
  • Optional gracefulDegradation?: boolean

    Description

    Enable graceful degradation (return null instead of errors)

    Default

    true
  • Optional lazyConnect?: boolean

    Description

    Enable lazy connect

    Default

    true
  • Optional reconnectTimeoutDelta?: number

    Description

    Base timeout (ms) between reconnect attempts

    Default

    30_000
  • Optional reconnectTimeoutLimit?: number

    Description

    Maximum timeout (ms) between reconnect attempts

    Default

    30_000
  • Optional reconnectTimes?: number

    Description

    Maximum reconnect attempts before giving up

    Default

    -1

    Remarks

    -1 = infinite attempts

Settings

Member Visibility

Theme

On This Page

hostnameoptions