wget-improved

wget-improved simplifies retrieving files from any URL

Improvements over wuchengwei/node-wget

• Handles 3xx redirects (including infinite redirect loops)
• Passes URL parameters
• Better error reporting
• Does not write using append (uses w+ identical to wget)
• Handles gzip compression, allow you to automatically gunzip the stream

Install

npm install wget-improved --save

download(src, output, options)

1const wget = require('wget-improved');
2const src = 'http://nodejs.org/images/logo.svg';
3const output = '/tmp/logo.svg';
4const options = {
5    // see options below
6};
7let download = wget.download(src, output, options);
8download.on('error', function(err) {
9    console.log(err);
10});
11download.on('start', function(fileSize) {
12    console.log(fileSize);
13});
14download.on('end', function(output) {
15    console.log(output);
16});
17download.on('progress', function(progress) {
18    typeof progress === 'number'
19    // code to show progress bar
20});

request(options, callback)

1const wget = require('wget');
2const options = {
3    protocol: 'https',
4    host: 'raw.github.com',
5    path: '/Fyrd/caniuse/master/data.json',
6    proxy: 'http://host:port',
7    method: 'GET'
8};
9let req = wget.request(options, function(res) {
10    let content = '';
11    if (res.statusCode === 200) {
12        res.on('error', function(err) {
13            console.log(err);
14        });
15        res.on('data', function(chunk) {
16            content += chunk;
17        });
18        res.on('end', function() {
19            console.log(content);
20        });
21    } else {
22        console.log('Server respond ' + res.statusCode);
23    }
24});
25
26req.end();
27req.on('error', function(err) {
28    console.log(err);
29});

options

1
2options = {}
3    // Set to true to have any gzip stream automatically decompressed before saving
4    options.gunzip = false;
5    options.proxy = {};
6        options.proxy.protocol = 'http';
7        options.proxy.host = 'someproxy.org';
8        options.proxy.port = 1337;
9        options.proxy.proxyAuth = '{basic auth}';
10        options.proxy.headers = {'User-Agent': 'Node'};

CLI

1# If installed globally
2nwget https://raw.github.com/Fyrd/caniuse/master/data.json -O /tmp/data.json
3
4# If not installed globally
5./node_modules/.bin/nwget https://raw.github.com/Fyrd/caniuse/master/data.json -O /tmp/data.json

Changes from 2.0.0 to 3.0.0

Progress is now returned as a Number instead of a String

On start filesize can return null when the remote server does not provide content-length

Exception for not specifying protocol is now: Your URL must use either HTTP or HTTPS.

Supports handling redirects that return a relative URL.

You can now get events for the total number of bytes downloaded download.on('bytes', function(bytes) {}...)

Request headers can be specified by passing an object to options.headers.

Unit tests have been added for most download functionality and error cases. Tests are a requirement for all PRs going forward!