UNPKG

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