# @types/clear

> TypeScript definitions for clear

Latest version **0.1.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/clear
pnpm add @types/clear
yarn add @types/clear
bun add @types/clear
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2023-11-07 |
| First published | 2019-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/clear
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/clear
- npm.io page: https://npm.io/package/@types/clear

## Recent versions

- 0.1.4 (latest) — 2023-11-07
- 0.1.2 (ts3.6) — 2021-07-08
- 0.1.1 (ts3.3) — 2020-12-03
- 0.1.0 (ts2.7) — 2019-07-24
- 0.1.3 — 2023-10-17

## README

# Installation
> `npm install --save @types/clear`

# Summary
This package contains type definitions for clear (https://github.com/bahamas10/node-clear#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/clear.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/clear/index.d.ts)
````ts
interface ClearOptions {
    /**
     * Setting this to false will prevent this module from clearing the screen.
     * This will not remove anything from the screen, but instead move your cursor
     * to position 0,0. Much like printing a \r instead of a \n to reset the current line of output.
     *
     * @default true
     */
    fullClear?: boolean | undefined;
}

/**
 * Clear the terminal screen if possible.
 */
declare function clear(opts?: ClearOptions): void;
declare function clear(clear: boolean): void;

export = clear;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: none

# Credits
These definitions were written by [Connor Fitzgerald](https://github.com/connorjayfitzgerald).

---
_Source: https://npm.io/package/@types/clear · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._