Interface ITerminalConnection

An interface for a terminal session.



connectionStatus: Terminal.ConnectionStatus

The current connection status of the terminal.

A signal emitted when the terminal connection status changes.

disposed: ISignal<ITerminalConnection, void>

A signal emitted when the object is disposed.

isDisposed: boolean

Test whether the object has been disposed.


This property is always safe to access.

A signal emitted when a message is received from the server.

The model associated with the session.

name: string

Get the name of the terminal session.

serverSettings: ServerConnection.ISettings

The server settings for the session.


  • Dispose of the resources held by the object.


    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

  • Reconnect to the terminal.

    Returns Promise<void>

    A promise that resolves when the terminal has reconnected.

  • Send a message to the terminal session.


    Returns void

  • Shut down the terminal session.

    Returns Promise<void>

Generated using TypeDoc