Class Connection<T>

constructor

• new Connection<T extends BaseNode = BaseNode>(
      node: T,
      url: string,
      options?: ConnectionOptions,
  ): Connection<T>

  Constructor for the Connection class.

  Type Parameters

  • T extends BaseNode = BaseNode

    The type of node.

  Parameters

  • node: T

    The node instance.

  • url: string

    The WebSocket URL.

  • options: ConnectionOptions = {}

    The connection options.

  Returns Connection<T>

Readonlynode

options

OptionalsessionId

url

ws

backoff

• get backoff(): Backoff

  Getter for the backoff property.

  Returns Backoff

• set backoff(b: Backoff): void

  Setter for the backoff property.

  Parameters

  • b: Backoff

  Returns void

close

• close(code?: number, data?: string): Promise<void>

  Closes the WebSocket connection.

  Parameters

  • Optionalcode: number

    The close code.

  • Optionaldata: string

    The close data.

  Returns Promise<void>

connect

• connect(): void

  Connects to the WebSocket server.

  Returns void