Sha256: 8874a2231b59fc11660673a2148e2744426845ca58507dffae416314bee6aaa3
Contents?: true
Size: 752 Bytes
Versions: 48
Compression:
Stored size: 752 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([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)
Version data entries
48 entries across 46 versions & 3 rubygems