View source

typedef ReadlineOptions

package js.node

import js.node.Readline

Options object used by Readline.createInterface.

See also:

Fields

@:optionaloptionalterminal:Null<Bool>

true if the input and output streams should be treated like a TTY, and have ANSI/VT100 escape codes written to it.

@:optionaloptionaltabSize:Null<Int>

The number of spaces a tab is equal to (minimum 1). Default: 8.

@:optionaloptionalsignal:Null<AbortSignal>

Allows closing the interface using an AbortSignal. Aborting the signal will internally call close on the interface.

@:optionaloptionalremoveHistoryDuplicates:Null<Bool>

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

@:optionaloptionalprompt:Null<String>

The prompt string to use. Default: '> '.

@:optionaloptionaloutput:Null<IWritable>

The Writable stream to write readline data to.

input:IReadable

The Readable stream to listen to.

@:optionaloptionalhistorySize:Null<Int>

Maximum number of history lines retained. To disable the history set this value to 0.

@:optionaloptionalhistory:Null<Array<String>>

Initial list of history lines.

@:optionaloptionalescapeCodeTimeout:Null<Int>

The duration readline will wait for a character (when reading an ambiguous key sequence) in milliseconds.

@:optionaloptionalcrlfDelay:Null<Float>

If the delay between \r and \n exceeds crlfDelay milliseconds, both \r and \n will be treated as separate end-of-line input.

@:optionaloptionalcompleter:Null<ReadlineCompleterCallback>

An optional function used for Tab autocompletion.