Readline

The Readable stream to listen to.

Module: node:readline Support: Experimental

5 members: 5 undocumented

Static Methods

⚪ createInterface(options)

Creates a new readline.Interface instance.

⚪ clearLine(stream, dir, callback)

Clears the current line of the given TTY stream in a specified direction.

⚪ clearScreenDown(stream, callback)

Clears the screen from the current position of the cursor down.

⚪ cursorTo(stream, x, y, callback)

Moves the cursor to the specified position in the given TTY stream.

⚪ moveCursor(stream, dx, dy, callback)

Moves the cursor relative to its current position in the given TTY stream.

Options for creating a readline Interface instance.

Since: 1.1.0 Docs: Node.js Docs

11 members: 11 undocumented

⚪ input

The Readable stream to listen to.

⚪ output

The Writable stream to write readline data to.

⚪ completer

An optional function used for Tab autocompletion.

⚪ terminal

True if the input and output streams should be treated as a TTY.

⚪ prompt

True if the input and output streams should be treated as a TTY.

⚪ history

The prompt string to use.

⚪ historySize

Maximum number of history lines retained.

⚪ removeHistoryDuplicates

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

⚪ crlfDelay

Duration readline will wait for a character (in milliseconds).

⚪ tabSize

If true, the cursor will be placed below the prompt when the user hits tab but there are no completions.

⚪ signal

If true, input is not echoed.

---