Skip to content
@ac-kit

WebSocketConnectOptions

WebSocketConnectOptions = object

Defined in: packages/net-websocket/src/handshake/connect-websocket.ts:28

Options for connectWebSocket.

Properties

Section titled “Properties”

closeTimeoutMs

Section titled “closeTimeoutMs”

readonly closeTimeoutMs: number

Defined in: packages/net-websocket/src/handshake/connect-websocket.ts:33

See WebSocketPeerOptions.closeTimeoutMs. Required.

headers?

Section titled “headers?”

readonly optional headers?: HttpHeaders

Defined in: packages/net-websocket/src/handshake/connect-websocket.ts:39

Extra request fields, such as Origin or Authorization.

maxMessageSize

Section titled “maxMessageSize”

readonly maxMessageSize: number

Defined in: packages/net-websocket/src/handshake/connect-websocket.ts:30

See WebSocketPeerOptions.maxMessageSize. Required.

protocols?

Section titled “protocols?”

readonly optional protocols?: readonly string[]

Defined in: packages/net-websocket/src/handshake/connect-websocket.ts:36

Subprotocols to offer, in order of preference.

signal?

Section titled “signal?”

readonly optional signal?: AbortSignal

Defined in: packages/net-websocket/src/handshake/connect-websocket.ts:42

Abandons the handshake.