typedef ReadlineOptions

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

Default: checking isTTY on the output stream upon instantiation.

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.

The prompt string to use.

Default: '> '.

The Writable stream to write readline data to.

The Readable stream to listen to.

Maximum number of history lines retained. To disable the history set this value to 0. 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: 30.

The duration readline will wait for a character (when reading an ambiguous key sequence in milliseconds one that can both form a complete key sequence using the input read so far and can take additional input to complete a longer key sequence).

Default: 500.

If the delay between \r and \n exceeds crlfDelay milliseconds, both \r and \n will be treated as separate end-of-line input. crlfDelay will be coerced to a number no less than 100. It can be set to Infinity, in which case \r followed by \n will always be considered a single newline (which may be reasonable for reading files with \r\n line delimiter).

Default: 100.

An optional function used for Tab autocompletion.

See also:

• https://nodejs.org/api/readline.html#readline_use_of_the_completer_function