Class WebsocketAPIBase

ProtectedconnectionTimers

Protectedcleanup

• cleanup(ws: WebSocket): void

  Cleans up WebSocket connection resources. Removes all listeners and clears any associated timers for the provided WebSocket client.

  Parameters

  • ws: WebSocket

    The WebSocket client to clean up.

  Returns void

  void

ProtectedclearTimers

• clearTimers(connection: WebSocket): void

  Clears all timers associated with a WebSocket connection.

  Parameters

  • connection: WebSocket

    The WebSocket client instance to clear timers for.

  Returns void

  void

ProtectedconnectPool

• connectPool(url: string): Promise<void>

  Connects all WebSocket connections in the pool

  Parameters

  • url: string

    The Websocket server URL.

  Returns Promise<void>

  A promise that resolves when all connections are established.

ProtectedcreateWebSocket

• createWebSocket(url: string): WebSocket

  Creates a new WebSocket client instance.

  Parameters

  • url: string

    The URL to connect to.

  Returns WebSocket

  A new WebSocket client instance.

Protectedemit

• emit(
      event: "open" | "message" | "error" | "close" | "ping" | "pong",
      ...args: any[],
  ): void

  Parameters

  • event: "open" | "message" | "error" | "close" | "ping" | "pong"
  • ...args: any[]

  Returns void

ProtectedgetAvailableConnections

• getAvailableConnections(
      allowNonEstablishedWebsockets?: boolean,
  ): WebsocketConnection[]

  Retrieves available WebSocket connections based on the connection mode and readiness. In 'single' mode, returns the first connection in the pool. In 'pool' mode, filters and returns connections that are ready for use.

  Parameters

  • allowNonEstablishedWebsockets: boolean = false

    Optional flag to include non-established WebSocket connections.

  Returns WebsocketConnection[]

  An array of available WebSocket connections.

ProtectedgetConnection

• getConnection(allowNonEstablishedWebsockets?: boolean): WebsocketConnection

  Gets a WebSocket connection from the pool or single connection. If the connection mode is 'single', it returns the first connection in the pool. If the connection mode is 'pool', it returns an available connection from the pool, using a round-robin selection strategy. If no available connections are found, it throws an error.

  Parameters

  • allowNonEstablishedWebsockets: boolean = false

    A boolean indicating whether to allow connections that are not established.

  Returns WebsocketConnection

  The selected WebSocket connection.

ProtectedgetReconnectURL

• getReconnectURL(
      defaultURL: string,
      targetConnection: WebsocketConnection,
  ): string

  Returns the URL to use when reconnecting. Derived classes should override this to provide dynamic URLs.

  Parameters

  • defaultURL: string

    The URL originally passed during the first connection.
  • targetConnection: WebsocketConnection

    The WebSocket connection being connected.

  Returns string

  The URL to reconnect to.

ProtectedinitConnect

• initConnect(
      url: string,
      isRenewal?: boolean,
      connection?: WebsocketConnection,
  ): undefined | WebsocketConnection

  Initializes a WebSocket connection.

  Parameters

  • url: string

    The Websocket server URL.
  • isRenewal: boolean = false

    Whether this is a connection renewal.
  • Optionalconnection: WebsocketConnection

    An optional WebSocket connection to use.

  Returns undefined | WebsocketConnection

  The WebSocket connection.

ProtectedisConnectionReady

• isConnectionReady(
      connection: WebsocketConnection,
      allowNonEstablishedWebsockets?: boolean,
  ): boolean

  Checks if the provided WebSocket connection is ready for use. A connection is considered ready if it is open, has no pending reconnection, and has not been closed.

  Parameters

  • connection: WebsocketConnection

    The WebSocket connection to check.
  • allowNonEstablishedWebsockets: boolean = false

    An optional flag to allow non-established WebSocket connections.

  Returns boolean

  true if the connection is ready, false otherwise.

ProtectedonOpen

• onOpen(
      url: string,
      targetConnection: WebsocketConnection,
      oldWSConnection: WebSocket,
  ): void

  Handles the opening of a WebSocket connection.

  Parameters

  • url: string

    The URL of the WebSocket server.
  • targetConnection: WebsocketConnection

    The WebSocket connection being opened.
  • oldWSConnection: WebSocket

    The WebSocket client instance associated with the old connection.

  Returns void

ProtectedscheduleTimer

• scheduleTimer(
      connection: WebSocket,
      callback: () => void,
      delay: number,
      type?: "timeout" | "interval",
  ): Timeout

  Schedules a timer for a WebSocket connection and tracks it

  Parameters

  • connection: WebSocket

    WebSocket client instance
  • callback: () => void

    Function to execute when timer triggers
  • delay: number

    Time in milliseconds before callback execution
  • type: "timeout" | "interval" = 'timeout'

    Timer type ('timeout' or 'interval')

  Returns Timeout

  Timer handle

Protectedsend

• send<T = unknown>(
      payload: string,
      id?: string,
      promiseBased?: boolean,
      timeout?: number,
      connection?: WebsocketConnection,
  ): void | Promise<WebsocketApiResponse<T>>

  Sends a payload through the WebSocket connection.

  Type Parameters

  • T = unknown

  Parameters

  • payload: string

    Message to send.
  • Optionalid: string

    Optional request identifier.
  • promiseBased: boolean = true

    Whether to return a promise.
  • timeout: number = 5000

    Timeout duration in milliseconds.
  • Optionalconnection: WebsocketConnection

    The WebSocket connection to use.

  Returns void | Promise<WebsocketApiResponse<T>>

  A promise if promiseBased is true, void otherwise.

  Throws

  Error if not connected or WebSocket client is not set.