extract-zip-fork
v1.5.1
Published
unzip a zip file into a directory using 100% pure gluten-free organic javascript
Downloads
113
Readme
extract-zip
Unzip written in pure JavaScript. Extracts a zip into a directory. Available as a library or a command line program.
Uses the yauzl
ZIP parser.
Installation
Get the library:
npm install extract-zip --save
Install the command line program:
npm install extract-zip -g
JS API
var extract = require('extract-zip')
extract(source, {dir: target}, function (err) {
// extraction is complete. make sure to handle the err
})
Options
dir
- defaults toprocess.cwd()
defaultDirMode
- integer - Directory Mode (permissions) will default to493
(octal0755
in integer)defaultFileMode
- integer - File Mode (permissions) will default to420
(octal0644
in integer)onEntry
- function - if present, will be called with every entry from the zip file. forwarded from theentry
event from yauzl.
Default modes are only used if no permissions are set in the zip file.
CLI Usage
extract-zip foo.zip <targetDirectory>
If not specified, targetDirectory
will default to process.cwd()
.