UNPKG

776 BTypeScriptView Raw
1// Type definitions for clear 0.1
2// Project: https://github.com/bahamas10/node-clear#readme
3// Definitions by: Connor Fitzgerald <https://github.com/connorjayfitzgerald>
4// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
5
6interface ClearOptions {
7 /**
8 * Setting this to false will prevent this module from clearing the screen.
9 * This will not remove anything from the screen, but instead move your cursor
10 * to position 0,0. Much like printing a \r instead of a \n to reset the current line of output.
11 *
12 * @default true
13 */
14 fullClear?: boolean | undefined;
15}
16
17/**
18 * Clear the terminal screen if possible.
19 */
20declare function clear(opts?: ClearOptions): void;
21declare function clear(clear: boolean): void;
22
23export = clear;