ClusterClientOptionsType

ClusterClientOptionsType = object

Defined in: src/cluster/ClusterClientOptions.ts:7

Plain options-object shape accepted by a ClusterClient.

Properties

askTimeoutMs?

readonly optional askTimeoutMs?: number

Defined in: src/cluster/ClusterClientOptions.ts:25

Default ask timeout (ms). Default: 5_000.

---

clientIdentity?

readonly optional clientIdentity?: object

Defined in: src/cluster/ClusterClientOptions.ts:23

Host + port the client claims as its identity. The cluster uses this to route cluster-client-reply frames back over the right connection. Use a host:port that uniquely identifies this client instance — random defaults are fine because the cluster only needs it for connection routing, not for actual networking back to the client.

host

readonly host: string

port

readonly port: number

---

contactPoints

readonly contactPoints: ReadonlyArray<string>

Defined in: src/cluster/ClusterClientOptions.ts:13

Cluster nodes to dial. Each is a host:port or <system>@host:port string — the same shape Cluster.join accepts for seeds. Tried in order; on dial failure the next is attempted.

---

logger?

readonly optional logger?: Logger

Defined in: src/cluster/ClusterClientOptions.ts:29

Custom logger; default: ConsoleLogger at WARN.

---

systemName?

readonly optional systemName?: string

Defined in: src/cluster/ClusterClientOptions.ts:15

Synthetic system name embedded in the client’s hello. Default: ‘cluster-client’.

---

tls?

readonly optional tls?: TlsTransportOptionsType

Defined in: src/cluster/ClusterClientOptions.ts:27

Optional TLS config — must match the cluster’s.