Toggle the CLI cursor
JavaScript
Switch branches/tags
Clone or download
Latest commit 5a40333 Jan 9, 2017

readme.md

cli-cursor Build Status

Toggle the CLI cursor

The cursor is gracefully restored if the process exits.

Install

$ npm install --save 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 is useful to show or hide the cursor based on a boolean.

stream

Type: Stream
Default: process.stderr

License

MIT © Sindre Sorhus