Socket
Socket
Sign inDemoInstall

readline-utils

Package Overview
Dependencies
13
Maintainers
2
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    readline-utils

Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more.


Version published
Maintainers
2
Created

Readme

Source

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

Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more.

Install

Install with npm:

$ npm install --save readline-utils

Usage

var utils = require('readline-utils');

API

.createInterface

Create a readline interface with the given options.

Params

  • options {Object}

.up

Move cursor up by n lines.

Params

  • rl {Readline}: Readline interface
  • n {Number}: Lines up to move. Default is 1.

.down

Move cursor down by n lines.

Params

  • rl {Readline}: Readline interface
  • n {Number}: Lines down to move. Default is 1.

.left

Move cursor left by n colums.

Params

  • rl {Readline}: Readline interface
  • n {Number}: Characters to move left. Default is 1.

.right

Move cursor right by n colums.

Params

  • rl {Readline}: Readline interface
  • n {Number}: Characters to move right. Default is 1.

.move

Move cursor up, down, left or right by 1 line.

Params

  • rl {Readline}: Readline interface

Example

var utils = require('readline-utils');
var rl = utils.createInterface();
rl.input.on('keypress', function(str, key) {
  utils.move(rl, key);
});

.auto

Callback function for the keypress event, to automatically move cursor up, down, left or right by 1 line.

Params

  • rl {Readline}: Readline interface

Example

var utils = require('readline-utils');
var rl = utils.createInterface();
rl.input.on('keypress', utils.auto(rl));

.clearAfter

Clear n lines after the cursor.

Params

  • rl {Readline}: Readline interface
  • n {Number}: Number of lines to clear

.clearScreen

Clear the terminal.

Params

  • rl {Readline}: Readline interface
  • n {Number}: Number of lines to clear

.lastLine

Get the last line from the given str

Params

  • str {String}
  • returns {String}

.height

Get the height (rows) of the given str

Params

  • str {String}
  • returns {Number}

.hideCursor

Hide the cursor.

Params

  • rl {Readline}: Readline interface
  • returns {Object}: readline-utils object for chaining

.showCursor

Show the cursor.

Params

  • rl {Readline}: Readline interface
  • returns {Object}: readline-utils object for chaining

.close

Close the interface, remove event listeners, and restore/unmute prompt functionality

Params

  • rl {Readline}: Readline interface
  • returns {Object}: readline-utils object for chaining

.forceClose

Close the interface when the keypress is ^C

Params

  • rl {Readline}: Readline interface
  • returns {Object}: readline-utils object for chaining

.normalize

Normalize values from keypress events.

Params

  • str {String}: Keypress source string emitted by the keypress event.
  • key {Object}: Keypress key object emitted by the keypress event.
  • returns {Object}: Normalized event object

.eraseLines

Erase n lines

Params

  • n {Number}
  • returns {String}: Returns the unicode to erase lines

Example

utils.eraseLines(3);

.clearTrailingLines

Remove lines from the bottom of the terminal.

Params

  • rl {Number}: Readline interface
  • lines {Number}: Number of lines to remove
  • height {Number}: Content height
  • returns {Object}: Returns the readline-utils object for chaining

.cursorPosition

Remember the cursor position

  • returns {Object}: readline-utils object

.restoreCursorPos

Restore the cursor position to where it has been previously stored.

  • returns {Object}: readline-utils object

.cliWidth

Get the width of the terminal

Params

  • rl {Readline}: Readline interface
  • returns {Number}: Returns the number of columns.

.breakLines

Break lines longer than the cli width so we can normalize the natural line returns behavior accross terminals. (I don't see how this can work consistently. It seems brittle and will probably be replaced with https://github.com/jonschlinkert/word-wrap)

Params

  • lines {Array}: Array of lines
  • width {Number}: Terminal width

.forceLineReturn

Joins the lines returned from .breakLines.

Params

  • lines {Array|String}: String or array of lines.
  • width {Number}: Terminal width
  • returns {String}

.normalizeLF

Ensure the given str ends in a newline.

Params

  • str {String}: The input string
  • returns {String}

Example

console.log(utils.normalizeLF('foo'));
//=> 'foo\n'

Attribution

Some of this code was borrowed from [Inquirer][].

About

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.

Contributors

CommitsContributor
17jonschlinkert
7doowb

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 May 05, 2017.

Keywords

FAQs

Last updated on 05 May 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc