Interface ConnectionStateManager<T>

Pattern for handling connection state with events Useful for WebSocket connections, plugin loading, etc.

interface ConnectionStateManager<T> {
    state: "disconnected" | "connecting" | "connected" | "error";
    waitForConnection(timeout?): Promise<T>;
    subscribe(callback): (() => void);
    reconnect(): Promise<void>;
    data?: T;
}

Type Parameters

T = any

Index

Methods

waitForConnection subscribe reconnect

Properties

Methods

waitForConnection

waitForConnection(timeout?): Promise<T>
Wait for connection to be established
Parameters
- Optional timeout: number
Returns Promise<T>

subscribe

subscribe(callback): (() => void)
Subscribe to state changes
Parameters
- callback: ((state) => void)
  - - (state): void
    - Parameters
      state: ConnectionStateManager<T>
      Returns void
Returns (() => void)
- - (): void
  - Returns void

reconnect

reconnect(): Promise<void>
Manually trigger reconnection

Returns Promise<void>

Properties

state

state: "disconnected" | "connecting" | "connected" | "error"

Current connection state

`Optional` data

data?: T

Current data (if connected)