Toggle the CLI cursor
Package: cli-cursor
Created by: sindresorhus
Last modified: Wed, 12 Apr 2023 02:45:45 GMT
Version: 4.0.0
License: MIT
Downloads: 156,079,168
Repository: https://github.com/sindresorhus/cli-cursor
Install
npm install cli-cursor
yarn add cli-cursor
cli-cursor
Toggle the CLI cursor
The cursor is gracefully restored if the process exits.
Install
$ npm install cli-cursor
Usage
import cliCursor from '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.
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
