The interface for a terminal manager.


The manager is responsible for maintaining the state of running terminal sessions.

interface IManager {
    connectionFailure: ISignal<Terminal.IManager, NetworkError>;
    disposed: ISignal<Terminal.IManager, void>;
    isActive: boolean;
    isDisposed: boolean;
    isReady: boolean;
    ready: Promise<void>;
    runningChanged: ISignal<Terminal.IManager, Terminal.IModel[]>;
    serverSettings: ServerConnection.ISettings;
    connectTo(options): ITerminalConnection;
    dispose(): void;
    isAvailable(): boolean;
    refreshRunning(): Promise<void>;
    running(): IterableIterator<Terminal.IModel>;
    shutdown(name): Promise<void>;
    shutdownAll(): Promise<void>;
    startNew(options?): Promise<ITerminalConnection>;

Hierarchy (view full)

Implemented by


connectionFailure: ISignal<Terminal.IManager, NetworkError>

A signal emitted when there is a connection failure.

disposed: ISignal<Terminal.IManager, void>

A signal emitted when the object is disposed.

isActive: boolean

Whether the manager is active.

isDisposed: boolean

Test whether the object has been disposed.


This property is always safe to access.

isReady: boolean

Test whether the manager is ready.

ready: Promise<void>

A promise that fulfills when the manager is ready.

A signal emitted when the running terminals change.

serverSettings: ServerConnection.ISettings

The server settings for the manager.


  • 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