UNPKG

@jupyterlite/terminal

Version:
38 lines (37 loc) 1.57 kB
import type { Terminal } from '@jupyterlab/services'; import { ServerConnection } from '@jupyterlab/services'; import type { IExternalCommand, IStdinReply, IStdinRequest } from '@jupyterlite/cockle'; import type { ISignal } from '@lumino/signaling'; import type { ILiteTerminalAPIClient } from './tokens'; export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient { constructor(options?: { serverSettings?: ServerConnection.ISettings; }); /** * Set identifier for communicating with service worker. */ set browsingContextId(browsingContextId: string); /** * Function that handles stdin requests received from service worker. */ handleStdin(request: IStdinRequest): Promise<IStdinReply>; get isAvailable(): boolean; readonly serverSettings: ServerConnection.ISettings; startNew(options?: Terminal.ITerminal.IOptions): Promise<Terminal.IModel>; listRunning(): Promise<Terminal.IModel[]>; registerAlias(key: string, value: string): void; registerEnvironmentVariable(key: string, value: string | undefined): void; registerExternalCommand(options: IExternalCommand.IOptions): void; shutdown(name: string): Promise<void>; get terminalDisposed(): ISignal<this, string>; themeChange(isDarkMode?: boolean): void; private get _models(); private _nextAvailableName; private _aliases?; private _environment?; private _browsingContextId?; private _externalCommands; private _shellManager; private _shells; private _terminalDisposed; }