Class WebSocketAddon

constructor

• new WebSocketAddon(
      url: string | URL,
      options?: WebSocketAddonOptions,
  ): WebSocketAddon

  Creates an addon for url without opening the socket until activation.

  Parameters

  • url: string | URL
  • options: WebSocketAddonOptions = {}

  Returns WebSocketAddon

Readonlyready

status

• get status(): WebSocketAddonStatus

  Current connection lifecycle state.

  Returns WebSocketAddonStatus

activate

• activate(terminal: BrowserTerminal): void

  Attaches the addon and begins connecting. Called by terminal.loadAddon().

  Parameters

  • terminal: BrowserTerminal

  Returns void

dispose

• dispose(): void

  Closes the socket and connection, cancels reconnection, and releases listeners.

  Returns void

onStatusChange

• onStatusChange(listener: (status: WebSocketAddonStatus) => void): Disposable

  Subscribes to connection status transitions.

  Parameters

  • listener: (status: WebSocketAddonStatus) => void

  Returns Disposable