Interface SentinelConnectionOptions

interface SentinelConnectionOptions {
    connectTimeout?: number;
    disconnectTimeout?: number;
    enableTLSForSentinelMode?: boolean;
    failoverDetector?: boolean;
    family?: number;
    name?: string;
    natMap?: NatMap;
    path?: string;
    preferredSlaves?: PreferredSlaves;
    protocol?: ProtocolVersion;
    replyMapping?: ReplyMappingMode;
    role?: "master" | "slave";
    sentinelCommandTimeout?: number;
    sentinelMaxConnections?: number;
    sentinelPassword?: string;
    sentinelReconnectStrategy?: ((retryAttempts) => number | void);
    sentinelRetryStrategy?: ((retryAttempts) => number | void);
    sentinelTLS?: ConnectionOptions;
    sentinelUsername?: string;
    sentinels?: Partial<SentinelAddress>[];
    tls?: ConnectionOptions;
    updateSentinels?: boolean;
}

Properties

connectTimeout? disconnectTimeout? enableTLSForSentinelMode? failoverDetector? family? name? natMap? path? preferredSlaves? protocol? replyMapping? role? sentinelCommandTimeout? sentinelMaxConnections? sentinelPassword? sentinelReconnectStrategy? sentinelRetryStrategy? sentinelTLS? sentinelUsername? sentinels? tls? updateSentinels?

Properties

Optional connectTimeout

connectTimeout?: number

Optional disconnectTimeout

disconnectTimeout?: number

Optional enableTLSForSentinelMode

enableTLSForSentinelMode?: boolean

Optional failoverDetector

failoverDetector?: boolean

Optional family

family?: number

Optional name

name?: string

Master group name of the Sentinel

Optional natMap

natMap?: NatMap

Optional path

path?: string

Optional preferredSlaves

preferredSlaves?: PreferredSlaves

Optional protocol

protocol?: ProtocolVersion

Optional replyMapping

replyMapping?: ReplyMappingMode

Optional role

role?: "master" | "slave"

Default

"master"

Optional sentinelCommandTimeout

sentinelCommandTimeout?: number

Optional sentinelMaxConnections

sentinelMaxConnections?: number

Default

10

Optional sentinelPassword

sentinelPassword?: string

Optional sentinelReconnectStrategy

sentinelReconnectStrategy?: ((retryAttempts) => number | void)

Type declaration

    • (retryAttempts): number | void

    • Parameters

      • retryAttempts: number

      Returns number | void

Optional sentinelRetryStrategy

sentinelRetryStrategy?: ((retryAttempts) => number | void)

Type declaration

    • (retryAttempts): number | void

    • Parameters

      • retryAttempts: number

      Returns number | void

Optional sentinelTLS

sentinelTLS?: ConnectionOptions

Optional sentinelUsername

sentinelUsername?: string

Optional sentinels

sentinels?: Partial<SentinelAddress>[]

Optional tls

tls?: ConnectionOptions

Optional updateSentinels

updateSentinels?: boolean

Settings

Member Visibility

Theme

On This Page

connectTimeoutdisconnectTimeoutenableTLSForSentinelModefailoverDetectorfamilynamenatMappathpreferredSlavesprotocolreplyMappingrolesentinelCommandTimeoutsentinelMaxConnectionssentinelPasswordsentinelReconnectStrategysentinelRetryStrategysentinelTLSsentinelUsernamesentinelstlsupdateSentinels