# @types/knex-cleaner

> TypeScript definitions for knex-cleaner

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

## Install

```sh
npm install @types/knex-cleaner
pnpm add @types/knex-cleaner
yarn add @types/knex-cleaner
bun add @types/knex-cleaner
```

## Health

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

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.6 |
| Published | 2023-11-07 |
| First published | 2020-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51371 |
| Maintainers | types |

## Links

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

## Dependencies (2)

- [knex](https://npm.io/package/knex.md) >=2.3.0
- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 1.3.6 (latest) — 2023-11-07
- 1.3.3 (ts4.2) — 2022-12-23
- 1.3.2 (ts4.1) — 2021-07-27
- 1.3.1 (ts3.6) — 2021-07-08
- 1.3.0 (ts3.2) — 2020-11-19
- 1.3.5 — 2023-10-18
- 1.3.4 — 2023-09-14

## README

# Installation
> `npm install --save @types/knex-cleaner`

# Summary
This package contains type definitions for knex-cleaner (https://github.com/steven-ferguson/knex-cleaner).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/knex-cleaner.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/knex-cleaner/index.d.ts)
````ts
import { Knex } from "knex";

export interface KnexCleanerOptions {
    /**
     * Choose between simply deleting all rows from table or truncating it completely. Default is 'truncate'
     */
    mode?: "truncate" | "delete" | undefined;

    /**
     * Used to tell PostgresSQL to reset the ID counter, default is true
     */
    restartIdentity?: boolean | undefined;

    /**
     * List of tables to ignore. Empty array by default.
     */
    ignoreTables?: string[] | undefined;
}

export function clean(knex: Knex, options?: KnexCleanerOptions): Promise<void>;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [knex](https://npmjs.com/package/knex)

# Credits
These definitions were written by [Karol Goraus](https://github.com/Szarlus).

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