Function: useWebSockets()
function useWebSockets<T>(__namedParameters: object): void
Creates or joins mutiple existing WebSocket connections
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
__namedParameters | object | - |
__namedParameters.connections | WebSocketConnectionRequest<T>[] | Make sure that connections value is stable between renders |
__namedParameters.enabled? | boolean | - |
__namedParameters.protocols? | string | string[] | Any additional protocols to include in WebSocket connection make sure that the value is stable between renders |
__namedParameters.type? | "json" | "binary" | Type of websocket data |
Returns
void