An interface for a terminal session.

interface ITerminalConnection {
    connectionStatus: Terminal.ConnectionStatus;
    connectionStatusChanged: ISignal<ITerminalConnection, Terminal.ConnectionStatus>;
    disposed: ISignal<ITerminalConnection, void>;
    isDisposed: boolean;
    messageReceived: ISignal<ITerminalConnection, Terminal.IMessage>;
    model: Terminal.IModel;
    name: string;
    serverSettings: ServerConnection.ISettings;
    dispose(): void;
    reconnect(): Promise<void>;
    send(message): void;
    shutdown(): Promise<void>;



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