lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6929 Commits
131 Branches
446 Tags
325 MiB
 
 
 
 
 
 
Tree: 772b3bf4c8
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '772b3bf4c8'
${ noResults }
node/deps/npm/node_modules/read
isaacs 3ccee08759
npm: Upgrade to 1.1.49 		13 years ago
..
example npm: Upgrade to 1.1.45 13 years ago
lib npm: Upgrade to 1.1.49 13 years ago
node_modules/mute-stream npm: Upgrade to 1.1.46 13 years ago
test npm: Upgrade to 1.1.49 13 years ago
.npmignore npm: Upgrade to 1.1.45 13 years ago
LICENCE Upgrade npm to 1.1.17 13 years ago
README.md npm: Upgrade to 1.1.46 13 years ago
package.json npm: Upgrade to 1.1.49 13 years ago

README.md

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")
read(options, callback)

The callback gets called with either the user input, or the default specified, or an error, as callback(error, result, isDefault) node style.

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.
  • stdin Readable stream to get input data from. (default process.stdin)
  • stdout Writeable stream to write prompts to. (default: process.stdout)

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

CONTRIBUTING

Patches welcome.