Interface RedisClusterOptions<M, F, S, RESP, TYPE_MAPPING>

Client Side Caching configuration for the pool.

Enables Redis Servers and Clients to work together to cache results from commands sent to a server. The server will notify the client when cached results are no longer valid. In pooled mode, the cache is shared across all clients in the pool.

Note: Client Side Caching is only supported with RESP3.

Example: Anonymous cache configuration

const client = createCluster({
  clientSideCache: {
    ttl: 0,
    maxEntries: 0,
    evictPolicy: "LRU"
  },
  minimum: 5
});
Copy

Example: Using a controllable cache

const cache = new BasicPooledClientSideCache({
  ttl: 0,
  maxEntries: 0,
  evictPolicy: "LRU"
});
const client = createCluster({
  clientSideCache: cache,
  minimum: 5
});
Copy

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

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

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

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

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.

The number of milliseconds after the first post-ready node reconnection attempt before background cluster topology refreshes are triggered. Omitted or undefined uses the default delay of 5000. Use false or 0 to disable reconnect-triggered topology refreshes. A function can return the delay dynamically, or false/undefined/0 to skip the refresh attempt. Concurrent refreshes are de-duplicated.

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