Skip to main content

Interface: WebSocketShimOptions

Defined in: packages/utils/src/websocket-shim.ts:16

Configuration options for creating a WebSocket shim factory.

Properties

headers?

optional headers: Record<string, string>

Defined in: packages/utils/src/websocket-shim.ts:18

Optional headers to include in the WebSocket upgrade request (e.g., for authentication).


maxQueueBytes?

optional maxQueueBytes: number

Defined in: packages/utils/src/websocket-shim.ts:20

Optional maximum number of bytes that can be queued while in CONNECTING state. Defaults to unlimited.


metrics?

optional metrics: Metrics

Defined in: packages/utils/src/websocket-shim.ts:22

Optional metrics collector to track wsUpgradeRequests and wsMessages.