daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
node/deps/npm/node_modules/read
History
isaacs 3ccee08759 npm: Upgrade to 1.1.49 
- node-gyp@0.6.5
- abstracted-out configs
- publishing over proxies
- bugfixes to all the deps
 		2012-08-14 20:27:28 -07:00
..
example npm: Upgrade to 1.1.45 2012-07-24 12:34:13 -07:00
lib npm: Upgrade to 1.1.49 2012-08-14 20:27:28 -07:00
node_modules/mute-stream npm: Upgrade to 1.1.46 2012-08-02 08:09:47 -07:00
test npm: Upgrade to 1.1.49 2012-08-14 20:27:28 -07:00
.npmignore npm: Upgrade to 1.1.45 2012-07-24 12:34:13 -07:00
LICENCE Upgrade npm to 1.1.17 2012-04-18 09:36:40 -07:00
README.md npm: Upgrade to 1.1.46 2012-08-02 08:09:47 -07:00
package.json npm: Upgrade to 1.1.49 2012-08-14 20:27:28 -07:00

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.