Interface: ConnectionOptions

Defined in: glide-mq/src/types.ts:29

Options for connecting to a Valkey/Redis server or cluster.

Properties

addresses

addresses: object[];

Defined in: glide-mq/src/types.ts:30

host

host: string;

port

port: number;

---

clientAz?

clientAz?: string;

Defined in: glide-mq/src/types.ts:49

Availability zone of the client (e.g., 'us-east-1a'). Used with readFrom 'AZAffinity' or 'AZAffinityReplicasAndPrimary' to route read commands to nodes in the same AZ, reducing cross-AZ latency and cost.

---

clusterMode?

clusterMode?: boolean;

Defined in: glide-mq/src/types.ts:33

---

credentials?

credentials?:
  | PasswordCredentials
  | IamCredentials;

Defined in: glide-mq/src/types.ts:32

---

inflightRequestsLimit?

inflightRequestsLimit?: number;

Defined in: glide-mq/src/types.ts:54

Maximum concurrent in-flight requests per client connection. Passed through to GLIDE. Default: 1000.

---

readFrom?

readFrom?: ReadFrom;

Defined in: glide-mq/src/types.ts:43

Read strategy for the client. Controls how read commands are routed.

• 'primary': Always read from primary (default).
• 'preferReplica': Round-robin across replicas, fallback to primary.
• 'AZAffinity': Route reads to replicas in the same availability zone.
• 'AZAffinityReplicasAndPrimary': Route reads to any node in the same AZ.

AZ-based strategies require clientAz to be set.

---

requestTimeout?

requestTimeout?: number;

Defined in: glide-mq/src/types.ts:61

Request timeout in milliseconds. Commands that exceed this timeout throw a TimeoutError. Default: 500. Increase for operations that may take longer (e.g. FT.CREATE with many existing keys, FUNCTION LOAD with large libraries).

---

useTLS?

useTLS?: boolean;

Defined in: glide-mq/src/types.ts:31