UNPKG

1.14 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/clear`
3
4# Summary
5This package contains type definitions for clear (https://github.com/bahamas10/node-clear#readme).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/clear.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/clear/index.d.ts)
10````ts
11interface ClearOptions {
12 /**
13 * Setting this to false will prevent this module from clearing the screen.
14 * This will not remove anything from the screen, but instead move your cursor
15 * to position 0,0. Much like printing a \r instead of a \n to reset the current line of output.
16 *
17 * @default true
18 */
19 fullClear?: boolean | undefined;
20}
21
22/**
23 * Clear the terminal screen if possible.
24 */
25declare function clear(opts?: ClearOptions): void;
26declare function clear(clear: boolean): void;
27
28export = clear;
29
30````
31
32### Additional Details
33 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
34 * Dependencies: none
35
36# Credits
37These definitions were written by [Connor Fitzgerald](https://github.com/connorjayfitzgerald).
38
\No newline at end of file