PR-URL: https://github.com/nodejs/node/pull/16738 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> |
||
|---|---|---|
| .. | ||
| index.js | ||
| license | ||
| package.json | ||
| readme.md | ||
cli-cursor 
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