Class TerminalManager

constructor

• new TerminalManager(options?): TerminalManager

• Construct a new terminal manager.

  Parameters

  • options: TerminalManager.IOptions = {}

  Returns TerminalManager

Readonly serverSettings

connectionFailure

• get connectionFailure(): ISignal<this, Error>

• A signal emitted when there is a connection failure.

  Returns ISignal<this, Error>

isReady

• get isReady(): boolean

• Test whether the manager is ready.

  Returns boolean

ready

• get ready(): Promise<void>

• A promise that fulfills when the manager is ready.

  Returns Promise<void>

runningChanged

• get runningChanged(): ISignal<this, Terminal.IModel[]>

• A signal emitted when the running terminals change.

  Returns ISignal<this, Terminal.IModel[]>

connectTo

• connectTo(options): ITerminalConnection

• Parameters

  • options: Omit<Terminal.ITerminalConnection.IOptions, "serverSettings">

  Returns ITerminalConnection

dispose

• dispose(): void

• Dispose of the resources used by the manager.

  Returns void

isAvailable

• isAvailable(): boolean

• Whether the terminal service is available.

  Returns boolean

refreshRunning

• refreshRunning(): Promise<void>

• Force a refresh of the running terminals.

  Returns Promise<void>

  A promise that with the list of running terminals.

  Notes

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

running

• running(): IterableIterator<Terminal.IModel>

• Create an iterator over the most recent running terminals.

  Returns IterableIterator<Terminal.IModel>

  A new iterator over the running terminals.

shutdown

• shutdown(name): Promise<void>

• Shut down a terminal session by name.

  Parameters

  • name: string

  Returns Promise<void>

shutdownAll

• shutdownAll(): Promise<void>

• Shut down all terminal sessions.

  Returns Promise<void>

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

startNew

• startNew(options?): Promise<ITerminalConnection>

• Create a new terminal session.

  Parameters

  • Optional options: Terminal.ITerminal.IOptions

    The options used to create the terminal.

  Returns Promise<ITerminalConnection>

  A promise that resolves with the terminal connection instance.

  Notes

  The manager serverSettings will be used unless overridden in the options.