cli-cursor
TypeScript icon, indicating that this package has built-in type declarations

4.0.0 • Public • Published

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.

Package Sidebar

Install

npm i cli-cursor

Weekly Downloads

39,313,140

Version

4.0.0

License

MIT

Unpacked Size

4.45 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus