Optional
completerOptional
crlfIf 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).
Optional
escapeThe 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).
Optional
historyInitial 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.
Optional
historyMaximum 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
Optional
outputThe Writable
stream to write readline data to.
Optional
promptThe prompt string to use.
Optional
removeIf true
, when a new input line added to the history list duplicates an older one,
this removes the older line from the list.
Optional
signalAllows closing the interface using an AbortSignal.
Aborting the signal will internally call close
on the interface.
Optional
tabThe number of spaces a tab is equal to (minimum 1).
Optional
terminaltrue
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.
An optional function used for Tab autocompletion.