hjw 6c42b6a025 first commit 10 月之前
..
index.d.ts 6c42b6a025 first commit 10 月之前
index.js 6c42b6a025 first commit 10 月之前
license 6c42b6a025 first commit 10 月之前
package.json 6c42b6a025 first commit 10 月之前
readme.md 6c42b6a025 first commit 10 月之前

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