cli-cursor

Toggle the CLI cursor

Last updated 9 years ago by sindresorhus .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ npm install cli-cursor

SYNC missed versions from official npm registry.

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.}

Current Tags

5.0.0 ... latest (4 months ago)

9 Versions

Maintainers (1)

sindresorhus

Downloads

Total 7

Today 0

This Week 0

This Month 0

Last Day 0

Last Week 0

Last Month 1

Dependencies (1)

restore-cursor ^1.0.1

Dev Dependencies (2)

ava *
xo *

Dependents (20)