https://github.com/sboudrias/readline2
Node.js Readline façade fixing bugs and issues in v0.8 and v0.10
https://github.com/sboudrias/readline2
Last synced: 7 months ago
JSON representation
Node.js Readline façade fixing bugs and issues in v0.8 and v0.10
- Host: GitHub
- URL: https://github.com/sboudrias/readline2
- Owner: SBoudrias
- License: mit
- Created: 2014-01-29T04:16:24.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-11-19T23:32:37.000Z (almost 9 years ago)
- Last Synced: 2024-04-24T13:35:54.531Z (over 1 year ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 27
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
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.