Node readline.ReadLineOptions TypeScript interface | API Reference | Bun

An optional function used for Tab autocompletion.

If the delay between \r and

\r

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).

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.

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.

The Readable stream to listen to

The Writable stream to write readline data to.

The prompt string to use.

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

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

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

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.