The interface for a terminal manager.


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


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

  • Whether the terminal service is available.

    Returns boolean

  • Force a refresh of the running terminal sessions.

    Returns Promise<void>

    A promise that with the list of running sessions.


    This is not typically meant to be called by the user, since the manager maintains its own internal state.

  • Create an iterator over the known running terminals.

    Returns IterableIterator<Terminal.IModel>

    A new iterator over the running terminals.

  • Shut down a terminal session by name.


    • name: string

      The name of the terminal session.

    Returns Promise<void>

    A promise that resolves when the session is shut down.

  • Shut down all terminal sessions.

    Returns Promise<void>

    A promise that resolves when all of the sessions are shut down.

Generated using TypeDoc