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

Unzipper

Modern unzipper with support of async/await. This module use yauzl under the hood and has been designed to replace extract-zip.

Requirements

Node.js v10 or higher

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

Unzipper(filePath: string, options?: Unzipper.ConstructorOptions): void

Extract a zip file

const { join } = require("path");
const unzip = require("@slimio/unzipper");

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

⚠️ dir must be an absolute path.

Available options are described by the following TypeScript interface:

interface ConstructorOptions {
    dir?: string;
    log?: boolean;
}

dir : unzip directory target. (Default: process.cwd())
log : Log directories and files path (Default: false).

License

MIT