Class TerminalAPIClient

constructor

• new TerminalAPIClient(
      options?: { serverSettings?: ServerConnection.ISettings },
  ): TerminalAPIClient

• Create a new Terminal API client.

  Parameters

  • options: { serverSettings?: ServerConnection.ISettings } = {}

  Returns TerminalAPIClient

ReadonlyserverSettings

isAvailable

• get isAvailable(): boolean

• Whether terminals are available.

  Returns boolean

listRunning

• listRunning(): Promise<Terminal.IModel[]>

• List the running terminal sessions.

  Returns Promise<Terminal.IModel[]>

  A promise that resolves with the list of running session models.

shutdown

• shutdown(name: string): Promise<void>

• Shut down a terminal session by name.

  Parameters

  • name: string

    The name of the target session.

  Returns Promise<void>

  A promise that resolves when the session is shut down.

startNew

• startNew(options?: Terminal.ITerminal.IOptions): Promise<Terminal.IModel>

• Start a new terminal session.

  Parameters

  • options: Terminal.ITerminal.IOptions = {}

    The options used to create the terminal.

  Returns Promise<Terminal.IModel>

  A promise that resolves with the terminal session model.