Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/decompress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Installation

npm install --save @types/decompress

Summary

This package contains type definitions for decompress (https://github.com/kevva/decompress#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/decompress.

index.d.ts

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

export = decompress;

declare function decompress(
    input: string | Buffer,
    output?: string | decompress.DecompressOptions,
    opts?: decompress.DecompressOptions,
): Promise<decompress.File[]>;

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

    interface DecompressOptions {
        /**
         * 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[] | undefined;
        /**
         * Remove leading directory components from extracted files.
         * Default: 0
         */
        strip?: number | undefined;
    }
}

Additional Details

Last updated: Mon, 06 Nov 2023 22:41:05 GMT
Dependencies: @types/node

Credits

These definitions were written by York Yao, and Jesse Bethke.