Interface RedisClusterOptions<M, F, S>

Type Parameters

Hierarchy

Properties

defaults? functions? maxCommandRedirections? minimizeConnections? modules? nodeAddressMap? rootNodes scripts? useReplicas?

Properties

Optional defaults

defaults?: Partial<RedisClusterClientOptions>

Default values used for every client in the cluster. Use this to specify global values, for example: ACL credentials, timeouts, TLS configuration etc.

Optional functions

functions?: F

Optional maxCommandRedirections

maxCommandRedirections?: number

The maximum number of times a command will be redirected due to MOVED or ASK errors.

Optional minimizeConnections

minimizeConnections?: boolean

When true, .connect() will only discover the cluster topology, without actually connecting to all the nodes. Useful for short-term or PubSub-only connections.

Optional modules

modules?: M

Optional nodeAddressMap

nodeAddressMap?: NodeAddressMap

Mapping between the addresses in the cluster (see CLUSTER SHARDS) and the addresses the client should connect to Useful when the cluster is running on another network

rootNodes

rootNodes: RedisClusterClientOptions[]

Should contain details for some of the cluster nodes that the client will use to discover the "cluster topology". We recommend including details for at least 3 nodes here.

Optional scripts

scripts?: S

Optional useReplicas

useReplicas?: boolean

When true, distribute load by executing readonly commands (such as GET, GEOSEARCH, etc.) across all cluster nodes. When false, only use master nodes.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc