Interface ITerminalAPIClient

Interface for making requests to the Terminal API.

interface ITerminalAPIClient {
    isAvailable: boolean;
    serverSettings: ServerConnection.ISettings;
    listRunning(): Promise<Terminal.IModel[]>;
    shutdown(name: string): Promise<void>;
    startNew(options?: Terminal.ITerminal.IOptions): Promise<Terminal.IModel>;
}

Implemented by

TerminalAPIClient

Index

Properties

isAvailable serverSettings

Methods

listRunning shutdown startNew

Properties

`Readonly`isAvailable

isAvailable: boolean

Whether terminals are available.

`Readonly`serverSettings

serverSettings: ServerConnection.ISettings

The server settings for the client.

Methods

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.
- Defined in packages/services/src/terminal/terminal.ts:256

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.
- Defined in packages/services/src/terminal/terminal.ts:265

startNew

startNew(options?: Terminal.ITerminal.IOptions): Promise<Terminal.IModel>
Start a new terminal session.
Parameters
- Optionaloptions: Terminal.ITerminal.IOptions
  The options used to create the terminal.
Returns Promise<Terminal.IModel>
A promise that resolves with the session model.
- Defined in packages/services/src/terminal/terminal.ts:249