UNPKG

537 BTypeScriptView Raw
1interface ClearOptions {
2 /**
3 * Setting this to false will prevent this module from clearing the screen.
4 * This will not remove anything from the screen, but instead move your cursor
5 * to position 0,0. Much like printing a \r instead of a \n to reset the current line of output.
6 *
7 * @default true
8 */
9 fullClear?: boolean | undefined;
10}
11
12/**
13 * Clear the terminal screen if possible.
14 */
15declare function clear(opts?: ClearOptions): void;
16declare function clear(clear: boolean): void;
17
18export = clear;