@kui-shell/core/mdist/models/repl.d.ts

An Electron-based shell for cloud-native development

import { RawContent, RawResponse } from './entity';
import { KResponse } from './command';
import { ExecOptions, ExecOptionsWithUUID } from './execOptions';
export default interface REPL {
    /**
     * Quiet eval. Useful to execute one command from another, without
     * emitting output to the console.
     *
     */
    qexec<T extends KResponse>(command: string, block?: HTMLElement | boolean, contextChangeOK?: boolean, execOptions?: ExecOptions, nextBlock?: HTMLElement): Promise<T>;
    /**
     * Raw eval. Useful to execute one command from another, where you
     * want the original model back, not the view-oriented model.
     *
     */
    rexec<Raw extends RawContent>(command: string, execOptions?: ExecOptions): Promise<RawResponse<Raw>>;
    /**
     * Programmatic eval. Useful to execute one command from another,
     * e.g. as the result of a click handler --- where you would like
     * the REPL interaction to appear on the console.
     *
     */
    pexec<T extends KResponse>(command: string, execOptions?: ExecOptions): Promise<T>;
    /**
     * Execute a command in response to an in-view click in a sidecar
     * view. This is helpful if you wish to participate in the view
     * nesting logic, e.g. where clicking on a link in a sidecar allows
     * the user to return to the previous view. In contrast, `pexec`
     * calls will *not* participate in view stacking.
     *
     */
    click(command: string | (() => Promise<string>), evt: MouseEvent): Promise<void>;
    /**
     * Evaluate a command and place the result in the current active view for the given tab
     *
     */
    reexec<T extends KResponse>(command: string, execOptions: ExecOptionsWithUUID): Promise<T>;
    /**
     * Prepare a string to be part of a `command` argument to the *exec
     * functions, quoting and escaping as necessary.
     *
     */
    encodeComponent(component: string | number | boolean, quote?: string): string;
    /**
     * Split the given string into an argv
     *
     * @param [true] removeOuterQuotes
     * @param [false] removeInlineOuterQuotes
     *
     */
    split(str: string, removeOuterQuotes?: boolean, removeInlineOuterQuotes?: boolean): string[];
}