WebsocketClientOptionsType

Defined in: src/http/websocket/WebsocketClientOptions.ts:36

Plain options-object shape accepted by a WebsocketClientActor.

Extends

• BrokerCommonOptionsType

Type Parameters

TOut

TOut = unknown

TIn

TIn = unknown

Properties

circuitBreaker?

readonly optional circuitBreaker?: object

Defined in: src/io/broker/BrokerOptions.ts:48

Optional circuit-breaker around connectImplementation. After failureThreshold consecutive failed connect attempts the breaker opens for resetMs and rejects new attempts immediately.

failureThreshold

readonly failureThreshold: number

resetMs

readonly resetMs: number

Inherited from

BrokerCommonOptionsType.circuitBreaker

---

codec?

readonly optional codec?: WebsocketCodec<TOut, TIn>

Defined in: src/http/websocket/WebsocketClientOptions.ts:41

Wire codec. Default: jsonCodec<TOut, TIn>().

---

maxFrameBytes?

readonly optional maxFrameBytes?: number

Defined in: src/http/websocket/WebsocketClientOptions.ts:43

Inbound frame size cap; oversize frames are dropped with a warning. Default 1 MiB.

---

onInvalidMessage?

readonly optional onInvalidMessage?: "disconnect" | "drop" | "hook"

Defined in: src/http/websocket/WebsocketClientOptions.ts:45

What to do with an inbound frame the codec can’t decode. Default ‘drop’.

---

outboundBuffer?

readonly optional outboundBuffer?: number

Defined in: src/io/broker/BrokerOptions.ts:61

Maximum number of outbound messages buffered while the connection is connecting or disconnected. When the buffer is full the oldest message is dropped (FIFO eviction) and a BrokerBufferOverflow event is published. Default: 1000. Set to 0 to fail-fast (publish a BrokerNotConnected event and drop the message).

Inherited from

BrokerCommonOptionsType.outboundBuffer

---

pingIntervalMs?

readonly optional pingIntervalMs?: number

Defined in: src/http/websocket/WebsocketClientOptions.ts:47

Send a ping every pingIntervalMs to keep the connection alive. Default: disabled.

---

protocols?

readonly optional protocols?: string | readonly string[]

Defined in: src/http/websocket/WebsocketClientOptions.ts:39

---

reconnect?

readonly optional reconnect?: false | { factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

Defined in: src/io/broker/BrokerOptions.ts:35

Reconnect strategy applied when the underlying connection drops or connectImplementation throws. Default: exponential backoff starting at 200ms, doubling, capped at 30s, infinite attempts. Set to false to disable auto-reconnect (one-shot connections).

Union Members

false

---

Type Literal

{ factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

factor?

readonly optional factor?: number

initialDelayMs?

readonly optional initialDelayMs?: number

maxAttempts?

readonly optional maxAttempts?: number

Cap on retry attempts. Default: Infinity (retry forever).

maxDelayMs?

readonly optional maxDelayMs?: number

Inherited from

BrokerCommonOptionsType.reconnect

---

url?

readonly optional url?: string

Defined in: src/http/websocket/WebsocketClientOptions.ts:38

WebSocket URL (ws://… or wss://…). Required (ctor or HOCON).