Interface ReadLineOptions

interface ReadLineOptions {
    completer?: Completer | AsyncCompleter;
    crlfDelay?: number;
    escapeCodeTimeout?: number;
    history?: string[];
    historySize?: number;
    input: ReadableStream;
    output?: WritableStream;
    prompt?: string;
    removeHistoryDuplicates?: boolean;
    tabSize?: number;
    terminal?: boolean;
}

Properties

completer? crlfDelay? escapeCodeTimeout? history? historySize? input output? prompt? removeHistoryDuplicates? tabSize? terminal?

Properties

Optional completer

completer?: Completer | AsyncCompleter

Optional crlfDelay

crlfDelay?: number

Optional escapeCodeTimeout

escapeCodeTimeout?: number

Optional history

history?: string[]

Initial list of history lines. This option makes sense only if terminal is set to true by the user or by an internal output check, otherwise the history caching mechanism is not initialized at all.

Default

[]

Optional historySize

historySize?: number

input

input: ReadableStream

Optional output

output?: WritableStream

Optional prompt

prompt?: string

Optional removeHistoryDuplicates

removeHistoryDuplicates?: boolean

If true, when a new input line added to the history list duplicates an older one, this removes the older line from the list.

Default

false

Optional tabSize

tabSize?: number

Optional terminal

terminal?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc