Class EventWebSocketClient

Index

Constructors

Methods

connect disconnect getActiveSubscriptions getLocalSubscriptions getState isConnected on subscribe unsubscribe

Constructors

constructor

new EventWebSocketClient(
url: string,
options?: EventWebSocketOptions,
): EventWebSocketClient
Parameters
- url: string
- options: EventWebSocketOptions = {}
Returns EventWebSocketClient
- Defined in libs/communication/src/lib/event/event-ws.ts:118

Methods

connect

connect(): void
Connect to the WebSocket server

Returns void
- Defined in libs/communication/src/lib/event/event-ws.ts:136

disconnect

disconnect(): void
Disconnect from the WebSocket server

Returns void
- Defined in libs/communication/src/lib/event/event-ws.ts:161

getActiveSubscriptions

getActiveSubscriptions(): string[]
Get list of active subscriptions

Returns string[]
- Defined in libs/communication/src/lib/event/event-ws.ts:493

getLocalSubscriptions

getLocalSubscriptions(): string[]
Get list of local subscriptions (may not be active on server yet)

Returns string[]
- Defined in libs/communication/src/lib/event/event-ws.ts:500

getState

getState(): ConnectionState
Get current connection state

Returns ConnectionState
- Defined in libs/communication/src/lib/event/event-ws.ts:179

isConnected

isConnected(): boolean
Check if connected

Returns boolean
- Defined in libs/communication/src/lib/event/event-ws.ts:186

on

on(
event: "error" | "disconnected" | "connected" | "reconnecting",
callback: () => void,
): () => void
Register a lifecycle event callback
Parameters
- event: "error" | "disconnected" | "connected" | "reconnecting"
  Lifecycle event: 'connected', 'disconnected', 'reconnecting', 'error'
- callback: () => void
  Callback to invoke
Returns () => void
Unregister function
- Defined in libs/communication/src/lib/event/event-ws.ts:253

subscribe<T = any>(eventName: string, callback: EventCallback<T>): () => void
Subscribe to an event
Type Parameters
- T = any
Parameters
- eventName: string
  Name of the event to subscribe to
- callback: EventCallback<T>
  Callback to invoke when event is received
Returns () => void
Unsubscribe function
- Defined in libs/communication/src/lib/event/event-ws.ts:200

unsubscribe

unsubscribe(eventName: string): void
Unsubscribe from an event
Parameters
- eventName: string
  Name of the event to unsubscribe from
Returns void
- Defined in libs/communication/src/lib/event/event-ws.ts:220