read

For reading user input from stdin.

Similar to the readline builtin's question() method, but with a few more features.

Usage

var read = require("read")
try {
  const result = await read(options, callback)
} catch (er) {
  console.error(er)
}

Options

Every option is optional.

• prompt What to write to stdout before reading input.
• silent Don't echo the output as the user types it.
• replace Replace silenced characters with the supplied character value.
• timeout Number of ms to wait for user input before giving up.
• default The default value if the user enters nothing.
• edit Allow the user to edit the default value.
• terminal Treat the output as a TTY, whether it is or not.
• input Readable stream to get input data from. (default process.stdin)
• output Writable stream to write prompts to. (default: process.stdout)
• completer Autocomplete callback (see official api for details

If silent is true, and the input is a TTY, then read will set raw mode, and read character by character.

Contributing

Patches welcome.

Current Tags

• 2.1.0                                ...           latest (3 years ago)

15 Versions

• 2.1.0                                ...           3 years ago
• 2.0.0                                ...           3 years ago
• 1.0.7                                ...           10 years ago
• 1.0.6                                ...           10 years ago
• 1.0.5                                ...           12 years ago
• 1.0.4                                ...           13 years ago
• 1.0.3                                ...           13 years ago
• 1.0.2                                ...           13 years ago
• 1.0.1                                ...           13 years ago
• 1.0.0                                ...           13 years ago
• 0.1.1                                ...           13 years ago
• 0.1.0                                ...           13 years ago
• 0.0.3                                ...           13 years ago
• 0.0.2                                ...           14 years ago
• 0.0.1                                ...           14 years ago