From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001 From: Minteck Date: Tue, 21 Dec 2021 16:52:28 +0100 Subject: Commit --- node_modules/cli-cursor/readme.md | 55 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 node_modules/cli-cursor/readme.md (limited to 'node_modules/cli-cursor/readme.md') diff --git a/node_modules/cli-cursor/readme.md b/node_modules/cli-cursor/readme.md new file mode 100644 index 0000000..3478ac8 --- /dev/null +++ b/node_modules/cli-cursor/readme.md @@ -0,0 +1,55 @@ +# cli-cursor [![Build Status](https://travis-ci.org/sindresorhus/cli-cursor.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-cursor) + +> Toggle the CLI cursor + +The cursor is [gracefully restored](https://github.com/sindresorhus/restore-cursor) if the process exits. + + +## Install + +``` +$ npm install cli-cursor +``` + + +## Usage + +```js +const cliCursor = require('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. +
+
-- cgit