@types/delete-empty/README.md

TypeScript definitions for delete-empty

# Installation
> `npm install --save @types/delete-empty`

# Summary
This package contains type definitions for delete-empty (https://github.com/jonschlinkert/delete-empty).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/delete-empty.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/delete-empty/index.d.ts)
````ts
declare function deleteEmpty(dir: string, options: deleteEmpty.Options, cb: deleteEmpty.DeleteEmptyCallback): void;
declare function deleteEmpty(dir: string, cb: deleteEmpty.DeleteEmptyCallback): void;
declare function deleteEmpty(dir: string, options?: deleteEmpty.Options): Promise<string[]>;

declare namespace deleteEmpty {
    function sync(dir: string, options?: Options): string[];

    interface DeleteEmptyCallback {
        (err: Error | undefined | null, deleted: string[]): void;
    }

    interface Options {
        /**
         * Do a dry run without deleting any files
         * @default false
         */
        dryRun?: boolean | undefined;
        filter?: FilterFunction | undefined;
        junkRegex?: RegExp | undefined;
    }

    interface FilterFunction {
        (file: string, regex: RegExp): boolean;
    }
}

export = deleteEmpty;

````

### Additional Details
 * Last updated: Mon, 18 Nov 2024 02:09:20 GMT
 * Dependencies: none

# Credits
These definitions were written by [Alorel](https://github.com/Alorel), and [Piotr Błażejewicz](https://github.com/Alorel).