Interface: GatewayWebSocket
Defined in: src/http/realtime.ts:12
Node-style WebSocket adapter. Use a reviewed implementation; the SDK does not implement framing.
Example
`const factory: GatewayWebSocketFactory = (url, options) => new WebSocket(url, options);`
Properties
readyState
readonly readyState: number;
Defined in: src/http/realtime.ts:13
bufferedAmount
readonly bufferedAmount: number;
Defined in: src/http/realtime.ts:14
Methods
on()
on(event, listener): unknown;
Defined in: src/http/realtime.ts:18
Subscribe to Node-style socket events.
Parameters
| Parameter | Type |
|---|---|
event | string |
listener | (...args) => void |
Returns
unknown
Example
`socket.on('open', () => console.log('upgraded'));`
off()
off(event, listener): unknown;
Defined in: src/http/realtime.ts:22
Remove the exact registered listener.
Parameters
| Parameter | Type |
|---|---|
event | string |
listener | (...args) => void |
Returns
unknown
Example
`socket.off('open', onOpen);`
send()
send(data, callback): void;
Defined in: src/http/realtime.ts:26
Send one UTF-8 text frame and report transport errors through the callback.
Parameters
| Parameter | Type |
|---|---|
data | string |
callback | (error?) => void |
Returns
void
Example
`socket.send(JSON.stringify(event), onSent);`
close()
close(code): void;
Defined in: src/http/realtime.ts:30
Initiate a WebSocket close handshake.
Parameters
| Parameter | Type |
|---|---|
code | number |
Returns
void
Example
`socket.close(1000);`
terminate()
terminate(): void;
Defined in: src/http/realtime.ts:34
Force termination when a handshake or graceful close cannot finish.
Returns
void
Example
`socket.terminate();`