Sha256: 3ff7b406d84ccababc31d8daa303da3464702aba1c40382142ad9ae11f4fb168
Contents?: true
Size: 666 Bytes
Versions: 111
Compression:
Stored size: 666 Bytes
Contents
# 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)
Version data entries
111 entries across 111 versions & 6 rubygems