Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/client / / openWebSocketTransport

Function: openWebSocketTransport()

function openWebSocketTransport(options, listeners): Promise<Transport>;

Defined in: packages/client/src/transport/ws.ts:44

Open a WebSocket transport. Resolves once the underlying socket fires open (i.e. the upgrade succeeded + the subprotocol matches SUBPROTOCOL_NAME); rejects with a typed TransportFailedError / SubprotocolMismatchError / AuthFailedError otherwise.

Parameters

Parameter	Type
options	TransportOptions
listeners	TransportListeners

Returns

Promise<Transport>

Stable