Interface ReadLineOptions

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

Properties

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

Properties

input

input: ReadableStream

Optionaloutput

output?: WritableStream

Optionalcompleter

completer?: Completer | AsyncCompleter

Optionalterminal

terminal?: boolean

Optionalhistory

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

[]

OptionalhistorySize

historySize?: number

Optionalprompt

prompt?: string

OptionalcrlfDelay

crlfDelay?: number

OptionalremoveHistoryDuplicates

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

OptionalescapeCodeTimeout

escapeCodeTimeout?: number

OptionaltabSize

tabSize?: number

Settings

Member Visibility

On This Page

Properties