download ![Build Status](https://travis-ci.org/kevva/download.svg?branch=master)
Download and extract files effortlessly
Install
$ npm install --save download
Usage
If you're fetching an archive you can set extract: true
in options and
it'll extract it for you.
var Download = require('download');
var download = new Download()
.get('http://example.com/foo.zip', 'destFolder', { extract: true, strip: 1 })
.get('http://example.com/bar.jpg', 'destFolder')
.get({ url: 'http://example.com/bar.jpg', name: 'foobar.jpg' }, 'destFolder');
download.run(function (err) {
if (err) {
throw err;
}
console.log('Download complete!');
});
API
new Download(opts)
Creates a new Download
instance. Options defined here will be applied to all
downloads.
.get(file, dest, opts)
Add a file to download. The file
argument accepts a String
containing a URL
or an Object
with a URL and a desired name. For example { url: http://example.com/file.zip, name: 'foo.zip' }
.
Options defined here will only apply to the specified file.
.proxy(proxy)
Set proxy settings. Defaults to process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy;
.
.run(cb)
Downloads your files and returns an error if something has gone wrong.
Options
You can define options accepted by the request
module besides from the options below.
Type: Boolean
Default: false
If set to true
, try extracting the file using decompress.
strip
Type: Number
Default: 0
Equivalent to --strip-components
for tar.
License
MIT © Kevin Mårtensson