sesaparcours
    Preparing search index...

    Interface Cmd<TElement>

    interface Cmd<TElement = HTMLElement> {
        caret: (pos?: number) => number;
        clear_cache: () => Cmd;
        cmd: (options?: CmdOptions) => Cmd;
        column: (include_prompt: boolean) => number;
        commands: (fn: commandsCmdFunction) => Cmd & () => commandsCmdFunction<
            void,
        >;
        delete: (count: number, stay?: boolean) => string;
        destroy: () => Cmd;
        disable: (focus?: boolean) => Cmd;
        display_position: () => number & (value: number) => Cmd;
        enable: () => Cmd;
        get: (index: number) => TElement & () => TElement[] & <T extends string>() => T;
        hidden: () => JQuery;
        history: () => History<string>;
        insert: (value: string, stay?: boolean) => Cmd;
        invoke_key: (shortcut: string) => Cmd;
        isenabled: () => boolean;
        keymap: (
            shortcut: string,
            callback: keymapFunction<Cmd<HTMLElement>>,
        ) => Cmd & (shortcut: string) => keymapFunctionOptionalArg & (
            arg: keymapObject<Cmd<HTMLElement>>,
        ) => Cmd & () => keymapObjectOptionalArg;
        kill_text: () => string;
        less: (
            text: LessArgument,
            options?: { formatters?: boolean; keepWords?: boolean; wrap?: boolean },
        ) => JQueryTerminal;
        mask: (mask: string | boolean) => Cmd & <T extends string | boolean>() => T;
        name: (name: string) => Cmd & () => string;
        option: (name: CmdOption, value: any) => Cmd & (name: CmdOption) => any;
        position: () => JQueryCoordinates & <T extends number>() => number & (
            value: number,
            silent?: boolean,
        ) => Cmd;
        prompt: (prompt: cmdPrompt) => Cmd & (last_render: true) => string & <
            T extends cmdPrompt<Cmd<HTMLElement>>,
        >() => T;
        purge: () => Cmd;
        refresh: () => Cmd;
        resize: (
            handler?:
                | false
                | TypeEventHandler<TElement, null, TElement, TElement, "resize">,
        ) => this & (num_chars?: number) => Cmd;
        resizer: (arg: TypeOrString<anyFunction>) => JQuery;
        set: (command: string, stay?: boolean, silent?: boolean) => Cmd;
        show: (
            duration: Duration,
            easing: string,
            complete: (this: TElement) => void,
        ) => this & (
            duration: Duration,
            easing_complete: string | ((this: TElement) => void),
        ) => this & (
            duration_complete_options?:
                | Duration
                | ((this: TElement) => void)
                | EffectsOptions<TElement>,
        ) => this & () => Cmd;
        terminal: (
            interpreter?: TypeOrArray<Interpreter>,
            options?: TerminalOptions,
        ) => JQueryTerminal;
        text_length: () => number;
        visible: () => Cmd;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    caret: (pos?: number) => number
    clear_cache: () => Cmd
    cmd: (options?: CmdOptions) => Cmd
    column: (include_prompt: boolean) => number
    commands: (fn: commandsCmdFunction) => Cmd & () => commandsCmdFunction<void>
    delete: (count: number, stay?: boolean) => string
    destroy: () => Cmd
    disable: (focus?: boolean) => Cmd
    display_position: () => number & (value: number) => Cmd
    enable: () => Cmd
    get: (index: number) => TElement & () => TElement[] & <T extends string>() => T
    hidden: () => JQuery
    history: () => History<string>
    insert: (value: string, stay?: boolean) => Cmd
    invoke_key: (shortcut: string) => Cmd
    isenabled: () => boolean
    keymap: (shortcut: string, callback: keymapFunction<Cmd<HTMLElement>>) => Cmd & (
        shortcut: string,
    ) => keymapFunctionOptionalArg & (
        arg: keymapObject<Cmd<HTMLElement>>,
    ) => Cmd & () => keymapObjectOptionalArg
    kill_text: () => string
    less: (
        text: LessArgument,
        options?: { formatters?: boolean; keepWords?: boolean; wrap?: boolean },
    ) => JQueryTerminal
    mask: (mask: string | boolean) => Cmd & <T extends string | boolean>() => T
    name: (name: string) => Cmd & () => string
    option: (name: CmdOption, value: any) => Cmd & (name: CmdOption) => any
    position: () => JQueryCoordinates & <T extends number>() => number & (
        value: number,
        silent?: boolean,
    ) => Cmd
    prompt: (prompt: cmdPrompt) => Cmd & (last_render: true) => string & <
        T extends cmdPrompt<Cmd<HTMLElement>>,
    >() => T
    purge: () => Cmd
    refresh: () => Cmd
    resize: (
        handler?:
            | false
            | TypeEventHandler<TElement, null, TElement, TElement, "resize">,
    ) => this & (num_chars?: number) => Cmd
    resizer: (arg: TypeOrString<anyFunction>) => JQuery
    set: (command: string, stay?: boolean, silent?: boolean) => Cmd
    show: (
        duration: Duration,
        easing: string,
        complete: (this: TElement) => void,
    ) => this & (
        duration: Duration,
        easing_complete: string | ((this: TElement) => void),
    ) => this & (
        duration_complete_options?:
            | Duration
            | ((this: TElement) => void)
            | EffectsOptions<TElement>,
    ) => this & () => Cmd
    terminal: (
        interpreter?: TypeOrArray<Interpreter>,
        options?: TerminalOptions,
    ) => JQueryTerminal
    text_length: () => number
    visible: () => Cmd