0.2.0 • Published 5 years ago
@slimio/unzipper v0.2.0
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
Usage example
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") });
API
Unzipper(filePath: string, options?: Unzipper.ConstructorOptions): void
Extract a zip file
⚠️ 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
).
Dependencies
Name | Refactoring | Security Risk | Usage |
---|---|---|---|
yauzl | ⚠️Major | High | Unzipper for Node.js |
License
MIT