sesaparcours
    Preparing search index...

    Interface JQueryTerminal<TElement>

    interface JQueryTerminal<TElement = HTMLElement> {
        autologin: (
            user: string,
            token: string,
            silent?: boolean,
        ) => JQueryTerminal;
        before_cursor: (word?: boolean) => string;
        caret: (pos?: number) => number;
        clear: () => JQueryTerminal;
        clear_history_state: () => JQueryTerminal;
        cmd: () => Cmd;
        cols: () => number;
        commands: () => interpreterFunction;
        complete: (commands: string[], options?: CompleteOptions) => boolean;
        destroy: () => JQueryTerminal;
        disable: (silent?: boolean) => JQueryTerminal;
        echo: (
            arg: string,
            options: animationOptions & EchoOptions,
        ) => Promise<void> & <TValue = echoValueOrPromise>(
            arg: TValue,
            options?: EchoOptions,
        ) => JQueryTerminal;
        enable: (silent?: boolean) => JQueryTerminal;
        enabled: () => boolean;
        enter: (str: string, options: animationOptions) => Promise<void> & (
            str: string,
        ) => JQueryTerminal;
        error: (arg: errorArgument, options?: EchoOptions) => JQueryTerminal;
        exception: <T extends Error>(e: T, label?: string) => JQueryTerminal;
        exec: (
            command: string,
            silent?: boolean | execOptions,
            options?: execOptions,
        ) => Promise<void>;
        export_view: () => View;
        flush: (options?: { scroll?: boolean; update?: boolean }) => JQueryTerminal;
        focus: (
            handler?:
                | false
                | TypeEventHandler<TElement, null, TElement, TElement, "focus">,
        ) => this & (toggle?: boolean) => JQueryTerminal;
        freeze: (toggle?: boolean) => JQueryTerminal;
        frozen: () => boolean;
        geometry: () => geometry;
        get_command: () => string;
        get_output: () => string & (raw: boolean) => Lines;
        get_position: () => number;
        get_prompt: <T extends ExtendedPrompt>() => T;
        get_token: <T extends string | void>(local?: boolean) => T;
        greetings: () => JQueryTerminal;
        hidden: () => JQuery;
        history: () => History<string>;
        history_state: (toggle: boolean) => JQueryTerminal;
        id: () => number;
        import_view: (view: View) => JQueryTerminal;
        insert: (
            str: string,
            options: insertOptions & animationOptions,
        ) => Promise<void> & (str: string, stay?: boolean) => JQueryTerminal;
        invoke_key: (shortcut: string) => JQueryTerminal;
        is_bottom: () => boolean;
        keymap: (shortcut: string, callback: keymapFunction) => JQueryTerminal & (
            shortcut: string,
        ) => keymapFunctionOptionalArg & (arg: keymapObject) => JQueryTerminal & () => keymapObjectOptionalArg;
        last_index: () => number;
        less: (
            text: LessArgument,
            options?: { formatters?: boolean; keepWords?: boolean; wrap?: boolean },
        ) => JQueryTerminal;
        level: () => number;
        login: (
            auth: LoginFunction,
            infinite?: boolean,
            success?: () => void,
            error?: () => void,
        ) => JQueryTerminal;
        login_name: <T extends string | void>(local?: boolean) => T;
        logout: (local?: boolean) => JQueryTerminal;
        name: () => string;
        next: (selector?: string) => this & () => JQueryTerminal;
        option: (options: TerminalOptions | TerminalOption, value?: any) => any;
        pause: () => JQueryTerminal;
        paused: () => boolean;
        pop: (echoCommand?: string, silent?: boolean) => JQueryTerminal;
        prefix_name: (local?: boolean) => string;
        purge: () => JQueryTerminal;
        push: (
            interpreter: TypeOrArray<Interpreter>,
            options?: pushOptions,
        ) => JQueryTerminal;
        read: (
            message: string,
            success_or_options?: readOptions | ((result: string) => void),
            cancel?: voidFunction,
        ) => Promise<string>;
        refresh: () => JQueryTerminal;
        remove_line: (line: number) => JQueryTerminal;
        reset: () => JQueryTerminal;
        resize: (
            handler?:
                | false
                | TypeEventHandler<TElement, null, TElement, TElement, "resize">,
        ) => this & (width?: number, height?: number) => JQueryTerminal;
        resizer: (arg: TypeOrString<anyFunction>) => JQuery;
        resume: () => JQueryTerminal;
        rows: () => number;
        save_state: (
            command?: string,
            ignore_hash?: boolean,
            index?: number,
        ) => JQueryTerminal;
        scroll: (
            handler?:
                | false
                | TypeEventHandler<TElement, null, TElement, TElement, "scroll">,
        ) => this & (amount: number) => JQueryTerminal;
        scroll_to_bottom: () => JQueryTerminal;
        set_command: (command: string) => JQueryTerminal & (
            cmd: string,
            silent?: boolean,
        ) => JQueryTerminal;
        set_interpreter: (
            interpreter: TypeOrArray<Interpreter>,
            login?: LoginArgument,
        ) => JQueryTerminal;
        set_mask: (toggle?: string | boolean) => JQueryTerminal;
        set_position: (pos: number, relative?: boolean) => JQueryTerminal;
        set_prompt: (
            prompt: ExtendedPrompt,
            options: animationOptions,
        ) => Promise<void> & (prompt: ExtendedPrompt) => JQueryTerminal;
        set_token: (token?: string, local?: boolean) => JQueryTerminal;
        settings: () => any;
        signature: () => string;
        terminal: (
            interpreter?: TypeOrArray<Interpreter>,
            options?: TerminalOptions,
        ) => JQueryTerminal;
        text_length: () => number;
        token: <T extends string | void>(local?: boolean) => T;
        typing: (
            type: TypingAnimations,
            delay: number,
            message: string,
            finish: voidFunction,
        ) => Promise<void>;
        update: (
            line: number,
            str: string,
            options?: EchoOptions,
        ) => JQueryTerminal;
        version: () => string;
        visible: () => JQuery;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    autologin: (user: string, token: string, silent?: boolean) => JQueryTerminal
    before_cursor: (word?: boolean) => string
    caret: (pos?: number) => number
    clear: () => JQueryTerminal
    clear_history_state: () => JQueryTerminal
    cmd: () => Cmd
    cols: () => number
    commands: () => interpreterFunction
    complete: (commands: string[], options?: CompleteOptions) => boolean
    destroy: () => JQueryTerminal
    disable: (silent?: boolean) => JQueryTerminal
    echo: (arg: string, options: animationOptions & EchoOptions) => Promise<void> & <
        TValue = echoValueOrPromise,
    >(
        arg: TValue,
        options?: EchoOptions,
    ) => JQueryTerminal
    enable: (silent?: boolean) => JQueryTerminal
    enabled: () => boolean
    enter: (str: string, options: animationOptions) => Promise<void> & (
        str: string,
    ) => JQueryTerminal
    error: (arg: errorArgument, options?: EchoOptions) => JQueryTerminal
    exception: <T extends Error>(e: T, label?: string) => JQueryTerminal
    exec: (
        command: string,
        silent?: boolean | execOptions,
        options?: execOptions,
    ) => Promise<void>
    export_view: () => View
    flush: (options?: { scroll?: boolean; update?: boolean }) => JQueryTerminal
    focus: (
        handler?:
            | false
            | TypeEventHandler<TElement, null, TElement, TElement, "focus">,
    ) => this & (toggle?: boolean) => JQueryTerminal
    freeze: (toggle?: boolean) => JQueryTerminal
    frozen: () => boolean
    geometry: () => geometry
    get_command: () => string
    get_output: () => string & (raw: boolean) => Lines
    get_position: () => number
    get_prompt: <T extends ExtendedPrompt>() => T
    get_token: <T extends string | void>(local?: boolean) => T
    greetings: () => JQueryTerminal
    hidden: () => JQuery
    history: () => History<string>
    history_state: (toggle: boolean) => JQueryTerminal
    id: () => number
    import_view: (view: View) => JQueryTerminal
    insert: (
        str: string,
        options: insertOptions & animationOptions,
    ) => Promise<void> & (str: string, stay?: boolean) => JQueryTerminal
    invoke_key: (shortcut: string) => JQueryTerminal
    is_bottom: () => boolean
    keymap: (shortcut: string, callback: keymapFunction) => JQueryTerminal & (
        shortcut: string,
    ) => keymapFunctionOptionalArg & (arg: keymapObject) => JQueryTerminal & () => keymapObjectOptionalArg
    last_index: () => number
    less: (
        text: LessArgument,
        options?: { formatters?: boolean; keepWords?: boolean; wrap?: boolean },
    ) => JQueryTerminal
    level: () => number
    login: (
        auth: LoginFunction,
        infinite?: boolean,
        success?: () => void,
        error?: () => void,
    ) => JQueryTerminal
    login_name: <T extends string | void>(local?: boolean) => T
    logout: (local?: boolean) => JQueryTerminal
    name: () => string
    next: (selector?: string) => this & () => JQueryTerminal
    option: (options: TerminalOptions | TerminalOption, value?: any) => any
    pause: () => JQueryTerminal
    paused: () => boolean
    pop: (echoCommand?: string, silent?: boolean) => JQueryTerminal
    prefix_name: (local?: boolean) => string
    purge: () => JQueryTerminal
    push: (
        interpreter: TypeOrArray<Interpreter>,
        options?: pushOptions,
    ) => JQueryTerminal
    read: (
        message: string,
        success_or_options?: readOptions | ((result: string) => void),
        cancel?: voidFunction,
    ) => Promise<string>
    refresh: () => JQueryTerminal
    remove_line: (line: number) => JQueryTerminal
    reset: () => JQueryTerminal
    resize: (
        handler?:
            | false
            | TypeEventHandler<TElement, null, TElement, TElement, "resize">,
    ) => this & (width?: number, height?: number) => JQueryTerminal
    resizer: (arg: TypeOrString<anyFunction>) => JQuery
    resume: () => JQueryTerminal
    rows: () => number
    save_state: (
        command?: string,
        ignore_hash?: boolean,
        index?: number,
    ) => JQueryTerminal
    scroll: (
        handler?:
            | false
            | TypeEventHandler<TElement, null, TElement, TElement, "scroll">,
    ) => this & (amount: number) => JQueryTerminal
    scroll_to_bottom: () => JQueryTerminal
    set_command: (command: string) => JQueryTerminal & (
        cmd: string,
        silent?: boolean,
    ) => JQueryTerminal
    set_interpreter: (
        interpreter: TypeOrArray<Interpreter>,
        login?: LoginArgument,
    ) => JQueryTerminal
    set_mask: (toggle?: string | boolean) => JQueryTerminal
    set_position: (pos: number, relative?: boolean) => JQueryTerminal
    set_prompt: (prompt: ExtendedPrompt, options: animationOptions) => Promise<void> & (
        prompt: ExtendedPrompt,
    ) => JQueryTerminal
    set_token: (token?: string, local?: boolean) => JQueryTerminal
    settings: () => any
    signature: () => string
    terminal: (
        interpreter?: TypeOrArray<Interpreter>,
        options?: TerminalOptions,
    ) => JQueryTerminal
    text_length: () => number
    token: <T extends string | void>(local?: boolean) => T
    typing: (
        type: TypingAnimations,
        delay: number,
        message: string,
        finish: voidFunction,
    ) => Promise<void>
    update: (line: number, str: string, options?: EchoOptions) => JQueryTerminal
    version: () => string
    visible: () => JQuery