ContextQMD
Back to Ioredis

SentinelConnectionOptions

docs/interfaces/SentinelConnectionOptions.html

5.10.12.8 KB
Original Source

Hierarchy

  • SentinelConnectionOptions

Index

Properties

Properties

Optional connectTimeout

connectTimeout?: number

Optional disconnectTimeout

disconnectTimeout?: number

Optional enableTLSForSentinelMode

enableTLSForSentinelMode?: boolean

Optional failoverDetector

failoverDetector?: boolean

Optional name

name?: string

Master group name of the Sentinel

Optional natMap

natMap?: NatMap

Optional preferredSlaves

preferredSlaves?: PreferredSlaves

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) => number | void)

Type declaration

    • (retryAttempts: number): number | void

Parameters

-
retryAttempts: number

Returns number | void

Optional sentinelRetryStrategy

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

Type declaration

    • (retryAttempts: number): 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

Generated using TypeDoc