Package Exports
- read
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (read) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
For reading user input from stdin.
USAGE
var read = require("read")
read(options, callback)The callback gets called with either the user input, or the default
specified, or an error, in the traditional callback(error, result)
node style.
OPTIONS
Every option is optional.
promptWhat to write to stdout before reading input.silentDon't echo the output as the user types it.numMax number of chars to read from terminal.delimThe char that means we're done. Default:"\n"timeoutNumber of ms to wait for user input before giving up.defaultThe default value if the user enters nothing.
If silent is true, or num is set, or delim is something other than
"\n", then read will set raw mode, and read character by character.
At this time, backspace and arrow keys are not supported in raw mode. It's probably not too hard to add support for this, perhaps using node's built-in readline module.
CONTRIBUTING
Patches welcome.
BUGS
In node 0.6.0 through 0.6.5, you must explicitly call
process.stdin.destroy() or process.exit() when you know that your
program is done reading, or else it will keep the event loop running
forever.