@jupyterlite/terminal/lib/tokens.d.ts

A terminal for JupyterLite

import type { Terminal } from '@jupyterlab/services';
import type { Contents } from '@jupyterlab/services';
import type { IExternalCommand, IOutputCallback, IShell, IStdinReply, IStdinRequest } from '@jupyterlite/cockle';
import { Token } from '@lumino/coreutils';
import type { ISignal } from '@lumino/signaling';
export declare const ILiteTerminalAPIClient: Token<ILiteTerminalAPIClient>;
export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
    /**
     * Identifier for communicating with service worker.
     */
    browsingContextId: string;
    /**
     * The JupyterLite content manager, used for DriveFS requests via SharedArrayBuffer.
     */
    contentsManager?: Contents.IManager;
    /**
     * Function that handles stdin requests received from service worker.
     */
    handleStdin(request: IStdinRequest): Promise<IStdinReply>;
    /**
     * Register an alias that will be available in all terminals.
     * If the key has already been registered, it will be overwritten.
     */
    registerAlias(key: string, value: string): void;
    /**
     * Register an environment variable that will be available in all terminals.
     * If the key has already been registered, it will be overwritten.
     * A key with an undefined value will be deleted if already registered.
     */
    registerEnvironmentVariable(key: string, value: string | undefined): void;
    /**
     * Register an external command that will be available in all terminals.
     */
    registerExternalCommand(options: IExternalCommand.IOptions): void;
    /**
     * Create a headless cockle shell that shares the client's stdin routing,
     * aliases, environment variables, and external commands. The returned shell
     * is already started and ready to receive input via `input()`.
     */
    createHeadlessShell(options: {
        shellId: string;
        cwd?: string;
        environment?: {
            [key: string]: string | undefined;
        };
        outputCallback: IOutputCallback;
        readyTimeoutMs?: number;
    }): Promise<IShell>;
    /**
     * Signal emitted when a terminal is disposed.
     * The string argument is the terminal `name` which is the same as the Shell's `shellId`.
     */
    terminalDisposed: ISignal<this, string>;
    /**
     * Inform all terminals that the theme has changed so that they can react to it if they wish.
     */
    themeChange(isDarkMode?: boolean): void;
}