"Fossies" - the Fresh Open Source Software Archive

Member "node-v12.18.4-win-x86/node_modules/npm/node_modules/read/README.md" (14 Feb 2020, 1774 Bytes) of package /windows/www/node-v12.18.4-win-x86.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.


For reading user input from stdin.

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


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.


Every option is optional.

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


This module works sort of with node 0.6. It does not work with node versions less than 0.6. It is best on node 0.8.

On node version 0.6, it will remove all listeners on the input stream’s data and keypress events, because the readline module did not fully clean up after itself in that version of node, and did not make it possible to clean up after it in a way that has no potential for side effects.

Additionally, some of the readline options (like terminal) will not function in versions of node before 0.8, because they were not implemented in the builtin readline module.


Patches welcome.