diff options
Diffstat (limited to 'tools/eslint/node_modules/readline2/README.md')
| -rw-r--r-- | tools/eslint/node_modules/readline2/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/tools/eslint/node_modules/readline2/README.md b/tools/eslint/node_modules/readline2/README.md new file mode 100644 index 0000000000..5a677a4e6c --- /dev/null +++ b/tools/eslint/node_modules/readline2/README.md @@ -0,0 +1,33 @@ +readline2 [](https://travis-ci.org/SBoudrias/readline2) +========= + +Node.js (v0.8 and v0.10) had some bugs and issues with the default [Readline](http://nodejs.org/api/readline.html) module. + +This module include fixes seen in later version (0.11-0.12 and iojs) and ease some undesirable behavior one could see using the readline to create interatives prompts. This means `readline2` change some behaviors and as so is **not** meant to be an exact drop-in replacement. + +This project is extracted from the core of [Inquirer.js interactive prompt interface](https://github.com/SBoudrias/Inquirer.js) to be available as a standalone module. + + +Documentation +------------- + +**Installation**: `npm install --save readline2` + +### readline2.createInterface(options); -> {Interface} + +Present the same API as [Node.js `readline.createInterface()`](http://nodejs.org/api/readline.html) + +#### Improvements +- Default `options.input` as `process.stdin` +- Default `options.output` as `process.stdout` +- `interface.stdout` is wrapped in a [MuteStream](https://github.com/isaacs/mute-stream) +- Prevent `up` and `down` keys from moving through history inside the readline +- Fix cursor position after a line refresh when the `Interface` prompt contains ANSI colors +- Correctly return the cursor position when faced with implicit line returns + + +License +------------- + +Copyright (c) 2012 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart)) +Licensed under the MIT license. |