History

juanelas c29b520108 JS Standard. Some fixes with the test. Better structure		2020-04-06 13:17:22 +02:00
..
index.d.ts	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
index.js	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
license	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
package.json	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
readme.md	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00

readme.md

cli-cursor

Toggle the CLI cursor

The cursor is gracefully restored if the process exits.

Install

$ npm install cli-cursor

Usage

const cliCursor = require('cli-cursor');

cliCursor.hide();

const unicornsAreAwesome = true;
cliCursor.toggle(unicornsAreAwesome);

API

.show(stream?)

.hide(stream?)

.toggle(force?, stream?)

force

Useful for showing or hiding the cursor based on a boolean.

stream

Type: stream.Writable
Default: process.stderr

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}