source: trip-planner-front/node_modules/cli-cursor/readme.md@ 6a3a178

Last change on this file since 6a3a178 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 1.1 KB
Line 
1# cli-cursor [![Build Status](https://travis-ci.org/sindresorhus/cli-cursor.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-cursor)
2
3> Toggle the CLI cursor
4
5The cursor is [gracefully restored](https://github.com/sindresorhus/restore-cursor) if the process exits.
6
7
8## Install
9
10```
11$ npm install cli-cursor
12```
13
14
15## Usage
16
17```js
18const cliCursor = require('cli-cursor');
19
20cliCursor.hide();
21
22const unicornsAreAwesome = true;
23cliCursor.toggle(unicornsAreAwesome);
24```
25
26
27## API
28
29### .show(stream?)
30
31### .hide(stream?)
32
33### .toggle(force?, stream?)
34
35#### force
36
37Useful for showing or hiding the cursor based on a boolean.
38
39#### stream
40
41Type: `stream.Writable`<br>
42Default: `process.stderr`
43
44
45---
46
47<div align="center">
48 <b>
49 <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>
50 </b>
51 <br>
52 <sub>
53 Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
54 </sub>
55</div>
Note: See TracBrowser for help on using the repository browser.