tree: 4c55bbe3b781e5f2d873373781549a8ff136b4bf [path history] [tgz]
  1. index.js
  2. license
  3. package.json
  4. readme.md
node_modules/cli-cursor/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