npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

readline-ui

v2.2.3

Published

Create a readline interface with default settings to use in prompts.

Downloads

168,273

Readme

readline-ui NPM version NPM monthly downloads NPM total downloads Linux Build Status

Create a readline interface with default settings to use in prompts.

Install

Install with npm:

$ npm install --save readline-ui

Usage

var UI = require('readline-ui');
var ui = new UI();

Example

example

The following example shows how to create a basic input prompt. This example is a greatly simplified version of prompt-base.

(This code is also in example.js if you want to run it yourself.)

var cyan = require('ansi-cyan');
var UI = require('readline-ui');
var ui = new UI();

// first, we need to render the "question" 
// to display in the terminal
var prompt = '? foo ';
ui.render(prompt);

// on keypress events, re-render the prompt 
// along with user input
ui.on('keypress', function() {
  ui.render(prompt + ui.rl.line);
});

// when the "line" event is emitted (from the "enter" keypress)
// we `.end()` to unmute the output stream then pause the readline. 
ui.on('line', function(answer) {
  ui.render(prompt + cyan(answer));
  ui.end();
  ui.rl.pause();
  console.log({color: answer});
});

API

.onKeypress

Handle keypress events.

Params

  • str {String}
  • key {Object}
  • returns {undefined}

.render

Render the prompt with the given input and optional footer.

Params

  • input {String}
  • footer {String}: (optional)
  • returns {undefined}

.clearLines

Remove n lines from the bottom of the terminal

Params

  • lines {Number}: Number of lines to remove

.cacheCursorPos

Cache the current cursor's column and line position.

  • returns {Object}: UI instance.

.restoreCursorPos

Restore the cursor position to the cached column and line.

  • returns {Object}: UI instance.

.resume

Resume the input stream.

.pause

Pause the input stream, allowing it to be resumed later if necessary.

.close

Close the readline.Interface instance and relinquish control over the input and output streams. Also removes event listeners, and restores/unmutes prompt functionality.

.forceClose

Close the interface when the keypress is ^C

.finish

Returns an "indentity" function that calls .close(), which can be used as the final .then() function with promises.

.end

Default method for writing a prompt to the terminal. This can be overridden.

.mute

Mutes the output stream that was used to create the readline interface, and returns a function for unmuting the stream. This is useful in unit tests.

  • returns {Function}

Example

// mute the stream
var unmute = ui.mute();

// unmute the stream
unmute();

.log

Unmute then write to the output stream that was used to create the readline interface, then re-mute the stream. Useful for debugging prompts.

Attribution

Inspired by the "screen manager" code in Inquirer.

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on June 04, 2017.