PK ‘]GMrÊO) ) index.jsnu W+A„¶ 'use strict';
const restoreCursor = require('restore-cursor');
let hidden = false;
exports.show = stream => {
const s = stream || process.stderr;
if (!s.isTTY) {
return;
}
hidden = false;
s.write('\u001b[?25h');
};
exports.hide = stream => {
const s = stream || process.stderr;
if (!s.isTTY) {
return;
}
restoreCursor();
hidden = true;
s.write('\u001b[?25l');
};
exports.toggle = (force, stream) => {
if (force !== undefined) {
hidden = force;
}
if (hidden) {
exports.show(stream);
} else {
exports.hide(stream);
}
};
PK ‘]GM{É
Û Û package.jsonnu W+A„¶ {
"name": "cli-cursor",
"version": "2.1.0",
"description": "Toggle the CLI cursor",
"license": "MIT",
"repository": "sindresorhus/cli-cursor",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
},
"engines": {
"node": ">=4"
},
"scripts": {
"test": "xo && ava"
},
"files": [
"index.js"
],
"keywords": [
"cli",
"cursor",
"ansi",
"toggle",
"display",
"show",
"hide",
"term",
"terminal",
"console",
"tty",
"shell",
"command-line"
],
"dependencies": {
"restore-cursor": "^2.0.0"
},
"devDependencies": {
"ava": "*",
"xo": "*"
},
"xo": {
"esnext": true
}
}
PK ‘]GMrÞN.ð ð readme.mdnu W+A„¶ # 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`
Default: `process.stderr`
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
PK ‘]GM‡
`á_ _ licensenu W+A„¶ The MIT License (MIT)
Copyright (c) Sindre Sorhus (sindresorhus.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
PK ‘]GMrÊO) ) index.jsnu W+A„¶ PK ‘]GM{É
Û Û a package.jsonnu W+A„¶ PK ‘]GMrÞN.ð ð x readme.mdnu W+A„¶ PK ‘]GM‡
`á_ _ ¡ licensenu W+A„¶ PK $ 7