TerminalAPIClient | @jupyterlab (original) (raw)

Implements

• ITerminalAPIClient

Index

Constructors

constructor

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

• Returns TerminalAPIClient

Properties

ReadonlyserverSettings

Accessors

isAvailable

• get isAvailable(): boolean

• Returns boolean

Methods

listRunning

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

• Returns Promise<Terminal.IModel[]>

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

shutdown

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

• Returns Promise<void>

A promise that resolves when the session is shut down.

startNew

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

• Returns Promise<Terminal.IModel>

A promise that resolves with the terminal session model.