gui/ui/node_modules.bak/cli-cursor
Snider fad16c8c76
Some checks failed
Security Scan / security (push) Failing after 34s
Test / test (push) Failing after 1m44s
chore: sync workspace dependencies
Co-Authored-By: Virgil <virgil@lethean.io>
2026-03-15 15:44:56 +00:00
..
index.d.ts chore: sync workspace dependencies 2026-03-15 15:44:56 +00:00
index.js chore: sync workspace dependencies 2026-03-15 15:44:56 +00:00
license chore: sync workspace dependencies 2026-03-15 15:44:56 +00:00
package.json chore: sync workspace dependencies 2026-03-15 15:44:56 +00:00
readme.md chore: sync workspace dependencies 2026-03-15 15:44:56 +00:00

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