download

What is download?

The 'download' npm package is a utility that allows you to download files over HTTP or HTTPS. It is a high-level function that abstracts away the complexity of making HTTP requests and handling streams, making it easier to download files.

What are download's main functionalities?

Downloading files

This feature allows you to download files from a given URL and save them to a specified directory. The function returns a promise that resolves when the download is complete.

const download = require('download');

download('https://example.com/somefile.png', 'dist').then(() => {
    console.log('File downloaded!');
});

Downloading and extracting archives

This feature enables the downloading of archive files like ZIP or TAR and automatically extracts them to a specified directory.

const download = require('download');

download('https://example.com/somearchive.zip', 'dist', { extract: true }).then(() => {
    console.log('Archive downloaded and extracted!');
});

Downloading files with options

This feature allows you to pass custom options such as headers, query parameters, and more, providing additional control over the HTTP request.

const download = require('download');

const options = {
    headers: { 'User-Agent': 'my-custom-agent' }
};

download('https://example.com/somefile.png', 'dist', options).then(() => {
    console.log('File downloaded with custom headers!');
});

Other packages similar to download

axios

Axios is a promise-based HTTP client for the browser and Node.js. It provides more general HTTP request capabilities compared to 'download' and is often used for API interactions rather than file downloads.

got

Got is a human-friendly and powerful HTTP request library for Node.js. Similar to 'download', it supports streaming but offers a more extensive set of HTTP capabilities, making it suitable for a wider range of HTTP requests.

request

Request is a simplified HTTP request client for Node.js. Although it has been deprecated, it was once a popular choice for making HTTP requests and supports file downloads, but with less abstraction compared to 'download'.

node-fetch

Node-fetch is a light-weight module that brings the Fetch API to Node.js. It is similar to 'download' in that it can be used to download files, but it is designed to closely mimic the browser fetch API.

README

download

Download and extract files

See download-cli for the command-line version.

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');

new Download({mode: '755'})
    .get('http://example.com/foo.zip')
    .get('http://example.com/cat.jpg')
    .dest('dest')
    .run();

API

new Download(options)

Creates a new Download instance.

options

Type: object

Options for got or the underlying http/https request can be specified, as well as options specific to the download module as described below.

options.extract

Type: boolean
Default: false

If set to true, try extracting the file using decompress.

options.mode

Type: string

Set mode on the downloaded file, i.e {mode: '755'}.

options.strip

Type: number
Default: 0

Remove leading directory components from extracted files.

.get(url, [dest])

url

Type: string

Add a URL to download.

dest

Type: string

Set an optional destination folder that will take precedence over the one set in .dest().

.dest(dir)

dir

Type: string

Set the destination folder to where your files will be downloaded.

.rename(name)

name

Type: function or string

Rename your files using gulp-rename.

.use(plugin)

plugin(response, url)

Type: function

Add a plugin to the middleware stack.

response

The response object.

url

The requested URL.

.run(callback)

callback(err, files)

Type: function

files

Contains an array of vinyl files.

License

MIT © Kevin Mårtensson