Blame view
node_modules/cli-cursor/readme.md
666 Bytes
f7563de62
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# cli-cursor [](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() ### .hide() ### .toggle(force) `force` is useful to show or hide the cursor based an a boolean. ## License MIT © [Sindre Sorhus](http://sindresorhus.com) |