blob: bfd4f63365b78af48893c3fd377d64264213a4d2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
declare const cliCursor: {
/**
Show cursor.
@param stream - Default: `process.stderr`.
@example
```
import cliCursor from 'cli-cursor';
cliCursor.show();
```
*/
show(stream?: NodeJS.WritableStream): void;
/**
Hide cursor.
@param stream - Default: `process.stderr`.
@example
```
import cliCursor from 'cli-cursor';
cliCursor.hide();
```
*/
hide(stream?: NodeJS.WritableStream): void;
/**
Toggle cursor visibility.
@param force - Is useful to show or hide the cursor based on a boolean.
@param stream - Default: `process.stderr`.
@example
```
import cliCursor from 'cli-cursor';
const unicornsAreAwesome = true;
cliCursor.toggle(unicornsAreAwesome);
```
*/
toggle(force?: boolean, stream?: NodeJS.WritableStream): void;
};
export default cliCursor;
|
