Package Exports

@slimio/unzipper

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 (@slimio/unzipper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@slimio/unzipper

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @slimio/unzipper
# or
$ yarn add @slimio/unzipper

API

unzip(filePath: string, options?: unzipOptions): void;

const unzip = require("@slimio/unzipper");

const filePath = "your/zip/file.zip";
await unzip(filePath);
// or
await unzip(filePath, { dir: "/to/specific/dir" });

Options

interface unzipOptions {
    dir: string;
    log: boolean;
    logFile: boolean;
}

dir : unzip directory target. Default : process.cwd();
log : Log directories and files path
logFile : Log all files content

License

MIT