feat: initial commit
This commit is contained in:
26
node_modules/cli-cursor/readme.md
generated
vendored
26
node_modules/cli-cursor/readme.md
generated
vendored
@@ -8,7 +8,7 @@ The cursor is [gracefully restored](https://github.com/sindresorhus/restore-curs
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install cli-cursor
|
||||
$ npm install --save cli-cursor
|
||||
```
|
||||
|
||||
|
||||
@@ -26,30 +26,20 @@ cliCursor.toggle(unicornsAreAwesome);
|
||||
|
||||
## API
|
||||
|
||||
### .show(stream?)
|
||||
### .show([stream])
|
||||
|
||||
### .hide(stream?)
|
||||
### .hide([stream])
|
||||
|
||||
### .toggle(force?, stream?)
|
||||
### .toggle(force, [stream])
|
||||
|
||||
#### force
|
||||
|
||||
Useful for showing or hiding the cursor based on a boolean.
|
||||
`force` is useful to show or hide the cursor based on a boolean.
|
||||
|
||||
#### stream
|
||||
|
||||
Type: `stream.Writable`<br>
|
||||
Type: `Stream`<br>
|
||||
Default: `process.stderr`
|
||||
|
||||
|
||||
---
|
||||
## License
|
||||
|
||||
<div align="center">
|
||||
<b>
|
||||
<a href="https://tidelift.com/subscription/pkg/npm-cli-cursor?utm_source=npm-cli-cursor&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
||||
</b>
|
||||
<br>
|
||||
<sub>
|
||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
||||
</sub>
|
||||
</div>
|
||||
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
||||
|
||||
Reference in New Issue
Block a user