0.2.6 • Published 8 years ago
got-zip v0.2.6
got-zip
Got a file zipped and then extract
Install
$ npm install --save got-zip
Usage
var gotZip = require('got-zip');
var zip = 'https://github.com/ragingwind/got-zip/archive/v0.2.2.zip';
gotZip(zip, {
dest: './.tmp',
extract: true,
cleanup: true,
exclude: ['readme.md'],
strip: 0
}).then(function () {
// downloading and extracting has been completed
}).catch(function (err) {
// manage error
});
CLI
$ npm install --global got-zip
$ got-zip --help
Usage
got-zip <url> <exclude-patterns>... <options>
Example
got-zip http://unicorns.com/unicorns.zip 'readme.md' --dest='./.tmp' --cleanup --extract
Options
--dest: path to download a zip file
--cleanup: remove the zip file after extracting
--extract: extract the zip file after downloading
--strip: remove leading folders in the path structure.
<url> url of zip file trying to download
<exclude-patterns> pattern to exclude some of the files when it is extracted
API
gotZip(input, options)
gotZip will returns promise
url
Required
Type: string
url of the zip file trying to download
options
dest
Type: string
path for downloading a zip file
extract
Type: bool
If set, zip will be extracted after downloading
cleanup
Type: bool
If set, zip will be deleted after extract
exclude
Type: string
You can give patterns to exclude some of the files when it is extracted
strip
Type: number
remove leading folders in the path structure. visit decompress-zip for further information.
License
MIT © Jimmy Moon