@types/knex-cleaner NPM

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

// Type definitions for knex-cleaner 1.3
// Project: https://github.com/steven-ferguson/knex-cleaner
// Definitions by: Karol Goraus <https://github.com/Szarlus>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 4.1
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>;