aboutsummaryrefslogtreecommitdiff
path: root/node_modules/cli-cursor/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/cli-cursor/readme.md')
-rw-r--r--node_modules/cli-cursor/readme.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/node_modules/cli-cursor/readme.md b/node_modules/cli-cursor/readme.md
new file mode 100644
index 0000000..75c18e5
--- /dev/null
+++ b/node_modules/cli-cursor/readme.md
@@ -0,0 +1,45 @@
+# 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 --save 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` is useful to show or hide the cursor based on a boolean.
+
+#### stream
+
+Type: `Stream`<br>
+Default: `process.stderr`
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)