Class TerminalManager

A terminal session manager.





_connectionFailure: any
_isReady: any
_names: any
_onDisposed: any

Handle a session terminating.

_onStarted: any

Handle a session starting.

_pollModels: any
_ready: any
_runningChanged: any
_terminalConnections: any
serverSettings: ServerConnection.ISettings

The server settings of the manager.


  • get _models(): any
  • Returns any

  • get connectionFailure(): ISignal<this, Error>
  • A signal emitted when there is a connection failure.

    Returns ISignal<this, Error>

  • get disposed(): ISignal<this, void>
  • A signal emitted when the delegate is disposed.

    Returns ISignal<this, void>

  • get isActive(): boolean
  • Whether the manager is active.

    Returns boolean

  • get isDisposed(): boolean
  • Test whether the delegate has been disposed.

    Returns boolean

  • get isReady(): boolean
  • Test whether the manager is ready.

    Returns boolean

  • get ready(): Promise<void>
  • A promise that fulfills when the manager is ready.

    Returns Promise<void>


  • Dispose of the resources used by the manager.

    Returns void

  • Whether the terminal service is available.

    Returns boolean

  • Force a refresh of the running terminals.

    Returns Promise<void>

    A promise that with the list of running terminals.


    This is intended to be called only in response to a user action, since the manager maintains its internal state.

  • Execute a request to the server to poll running terminals and update state.

    Returns Promise<void>

  • Create an iterator over the most recent running terminals.

    Returns IterableIterator<Terminal.IModel>

    A new iterator over the running terminals.

  • Shut down a terminal session by name.


    • name: string

    Returns Promise<void>

  • Shut down all terminal sessions.

    Returns Promise<void>

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

Generated using TypeDoc