| Server IP : 68.183.124.220 / Your IP : 216.73.217.137 Web Server : Apache/2.4.18 (Ubuntu) System : Linux Sandbox-A 4.4.0-210-generic #242-Ubuntu SMP Fri Apr 16 09:57:56 UTC 2021 x86_64 User : gavin ( 1000) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority, MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /home/gavin/workspace/readjs/node_modules/decompress-unzip/ |
Upload File : |
# decompress-unzip [](https://travis-ci.org/kevva/decompress-unzip)
> zip decompress plugin
## Install
```
$ npm install --save decompress-unzip
```
## Usage
```js
const Decompress = require('decompress');
const decompressUnzip = require('decompress-unzip');
new Decompress()
.src('foo.zip')
.dest('dest')
.use(decompressUnzip({strip: 1}))
.run();
```
You can also use this plugin with [gulp](http://gulpjs.com):
```js
const decompressUnzip = require('decompress-unzip');
const gulp = require('gulp');
const vinylAssign = require('vinyl-assign');
gulp.task('default', () => {
return gulp.src('foo.zip')
.pipe(vinylAssign({extract: true}))
.pipe(decompressUnzip({strip: 1}))
.pipe(gulp.dest('dest'));
});
```
## API
### decompressUnzip(options)
#### options.strip
Type: `number`
Default: `0`
Remove leading directory components from extracted files.
## License
MIT © [Kevin Mårtensson](https://github.com/kevva)