Skip to content

Documents for @litert/websocket / Client / IClientHandshakeOptions

Interface: IClientHandshakeOptions

Defined in: src/lib/Client.ts:149

The handshake options for WebSocket client.

Properties

subProtocols?

optional subProtocols: string[]

Defined in: src/lib/Client.ts:158

The sub-protocols to be requested.

If not specified, no sub-protocol will be requested. When the server can not recognize any of the requested sub-protocols, it might reject the handshake.