Function: useWebSocket()
function useWebSocket<T>(options: object): void
React hook for WebSocket subscription to Kubernetes resources
Type Parameters
| Type Parameter | Description |
|---|---|
T | Type of data expected from the WebSocket |
Parameters
| Parameter | Type | Description |
|---|---|---|
options | object | Configuration options for the WebSocket connection |
options.cluster? | string | The Kubernetes cluster ID to watch |
options.enabled? | boolean | Whether the WebSocket connection should be active |
options.onError? | (error: Error) => void | Callback function to handle connection errors |
options.onMessage | (data: T) => void | Callback function to handle incoming messages |
options.url | () => string | Function that returns the WebSocket URL to connect to |
Returns
void