WebSocketService

Manages WebSocket connections with automatic reconnection, heartbeat support, and typed message streams via Observables.

TypeScriptexample.ts
import { WebSocketService } from '@angular-helpers/browser-web-apis'

# Methods

MethodSignatureReturnsDescription
createClientcreateClient(config: WebSocketClientConfig): WebSocketClientWebSocketClientCreate a new WebSocket client. The client owns one connection and is the recommended surface for all interactions (status signal, request/response, reconnect, etc.). The returned client is automatically disposed when the host injector is destroyed.
disposeAlldisposeAll(): voidvoidDispose every client created via `createClient()` (also called automatically on destroy).
connectconnect(config: WebSocketConfig): Observable<WebSocketStatus>Observable<WebSocketStatus>Public method connect.
disconnectdisconnect(): voidvoidPublic method disconnect.
sendsend(message: WebSocketMessage<T>): voidvoidPublic method send.
sendRawsendRaw(data: string): voidvoidPublic method sendRaw.
getStatusgetStatus(): Observable<WebSocketStatus>Observable<WebSocketStatus>Public method getStatus.
getMessagesgetMessages(): Observable<WebSocketMessage<T>>Observable<WebSocketMessage<T>>Public method getMessages.
getMessagesByTypegetMessagesByType(type: string): Observable<WebSocketMessage<T>>Observable<WebSocketMessage<T>>Public method getMessagesByType.
getNativeWebSocketgetNativeWebSocket(): WebSocket | nullWebSocket | nullPublic method getNativeWebSocket.
isConnectedisConnected(): booleanbooleanPublic method isConnected.
getReadyStategetReadyState(): numbernumberPublic method getReadyState.
LCP N/A
CLS N/A
INP N/A