input-terminal
    Preparing search index...

    Interface TermOptionsConfig

    The configuration for the terminal.

    interface TermOptionsConfig {
        previousKey?: string;
        nextKey?: string;
        returnKey?: string;
        autocompleteKey?: string;
        installBuiltins?: boolean;
        prompt?: string;
        preprompt?: string;
        addEmptyCommandToHistory?: boolean;
        showDuplicateCommands?: boolean;
        [key: string]: any;
    }

    Implemented by

    Indexable

    • [key: string]: any

      Any other custom options.

    Index

    Properties

    previousKey? nextKey? returnKey? autocompleteKey? installBuiltins? prompt? preprompt? addEmptyCommandToHistory? showDuplicateCommands?

    Properties

    previousKey?: string

    The key used to select the previous command.

    "ArrowUp"
    nextKey?: string

    The key used to select the next command.

    "ArrowDown"
    returnKey?: string

    The key used to enter a command.

    "Enter"
    autocompleteKey?: string

    The key used to autocomplete a command.

    "Tab"
    installBuiltins?: boolean

    Whether the terminal should install built-in commands.

    true
    prompt?: string

    A line of text that is displayed at the beginning of the command line.

    "> "
    preprompt?: string

    A line of text that is displayed before the prompt.

    ""
    addEmptyCommandToHistory?: boolean

    Whether the terminal should add a command with empty input to history.

    false
    showDuplicateCommands?: boolean

    Whether the terminal should add a command with duplicate input (same as the last command's input) to history.

    false

    Settings

    Member Visibility

    On This Page

    Properties