Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bearjaws/node-wget
A download tool for nodejs that emulates the functionality of wget
https://github.com/bearjaws/node-wget
Last synced: 16 days ago
JSON representation
A download tool for nodejs that emulates the functionality of wget
- Host: GitHub
- URL: https://github.com/bearjaws/node-wget
- Owner: bearjaws
- License: mit
- Fork: true (wuchengwei/node-wget)
- Created: 2014-12-20T19:07:41.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2023-06-15T18:57:37.000Z (over 1 year ago)
- Last Synced: 2024-10-19T16:48:14.181Z (25 days ago)
- Language: JavaScript
- Homepage:
- Size: 95.7 KB
- Stars: 49
- Watchers: 2
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wget-improved
[](https://circleci.com/gh/bearjaws/node-wget/tree/master)
wget-improved simplifies retrieving files from any URL
Improvements over [wuchengwei/node-wget](https://github.com/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)
```js
const wget = require('wget-improved');
const src = 'http://nodejs.org/images/logo.svg';
const output = '/tmp/logo.svg';
const options = {
// see options below
};
let download = wget.download(src, output, options);
download.on('error', function(err) {
console.log(err);
});
download.on('start', function(fileSize) {
console.log(fileSize);
});
download.on('end', function(output) {
console.log(output);
});
download.on('progress', function(progress) {
typeof progress === 'number'
// code to show progress bar
});
```
## request(options, callback)
```js
const wget = require('wget');
const options = {
protocol: 'https',
host: 'raw.github.com',
path: '/Fyrd/caniuse/master/data.json',
proxy: 'http://host:port',
method: 'GET'
};
let req = wget.request(options, function(res) {
let content = '';
if (res.statusCode === 200) {
res.on('error', function(err) {
console.log(err);
});
res.on('data', function(chunk) {
content += chunk;
});
res.on('end', function() {
console.log(content);
});
} else {
console.log('Server respond ' + res.statusCode);
}
});
req.end();
req.on('error', function(err) {
console.log(err);
});
```
## options
```js
options = {}
// Set to true to have any gzip stream automatically decompressed before saving
options.gunzip = false;
options.proxy = {};
options.proxy.protocol = 'http';
options.proxy.host = 'someproxy.org';
options.proxy.port = 1337;
options.proxy.proxyAuth = '{basic auth}';
options.proxy.headers = {'User-Agent': 'Node'};
```
## CLI
```bash
# If installed globally
nwget https://raw.github.com/Fyrd/caniuse/master/data.json -O /tmp/data.json
# If not installed globally
./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!