input-terminal
    Preparing search index...

    Interface TermOptions

    The configuration for the terminal.

    interface TermOptions {
        previousKey: string;
        nextKey: string;
        returnKey: string;
        autocompleteKey: string;
        installBuiltins: boolean;
        prompt: string;
        preprompt: string;
        printCommand: boolean;
        addEmptyCommandToHistory: boolean;
        showDuplicateCommands: boolean;
        readonly [key: string]: unknown;
    }

    Indexable

    • readonly [key: string]: unknown

      Any other custom options.

    Index
    previousKey nextKey returnKey autocompleteKey installBuiltins prompt preprompt printCommand addEmptyCommandToHistory showDuplicateCommands
    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.

    ""
    printCommand: boolean

    Whether the terminal should print the full prompt and the user input to the output with each command.

    false
    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