hjw
6c42b6a025
first commit
|
10 months ago | |
|---|---|---|
| .. | ||
| index.d.ts | 10 months ago | |
| index.js | 10 months ago | |
| license | 10 months ago | |
| package.json | 10 months ago | |
| readme.md | 10 months ago | |
readme.md
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