diff options
Diffstat (limited to 'node_modules/cli-cursor/readme.md')
| -rw-r--r-- | node_modules/cli-cursor/readme.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/node_modules/cli-cursor/readme.md b/node_modules/cli-cursor/readme.md deleted file mode 100644 index addfea8..0000000 --- a/node_modules/cli-cursor/readme.md +++ /dev/null @@ -1,51 +0,0 @@ -# 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 -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` - ---- - -<div align="center"> - <b> - <a href="https://tidelift.com/subscription/pkg/npm-cli-cursor?utm_source=npm-cli-cursor&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> - </b> - <br> - <sub> - Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. - </sub> -</div> |