DefinitelyTyped/types/decompress/index.d.ts

// Type definitions for decompress 4.2
// Project: https://github.com/kevva/decompress#readme
// Definitions by: York Yao <https://github.com/plantain-00>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />

export = decompress;

declare function decompress(input: string | Buffer, output: string, opts?: Options): Promise<File>;

interface File {
    data: Buffer;
    mode: number;
    mtime: string;
    path: string;
    type: string;
}

interface Options {
    /**
     * Filter out files before extracting
     */
    filter?(file: File): boolean;
    /**
     * Map files before extracting
     */
    map?(file: File): File;
    /**
     * Array of plugins to use.
     * Default: [decompressTar(), decompressTarbz2(), decompressTargz(), decompressUnzip()]
     */
    plugins?: any[];
    /**
     * Remove leading directory components from extracted files.
     * Default: 0
     */
    strip?: number;
}