node package manager

download

download Build Status

Download and extract files

See download-cli for the command-line version.

Install

$ npm install --save download

Usage

const fs = require('fs');
const download = require('download');
 
download('http://unicorn.com/foo.jpg', 'dist').then(() => {
    console.log('done!');
});
 
download('http://unicorn.com/foo.jpg').then(data => {
    fs.writeFileSync('dist/foo.jpg', data);
});
 
download('unicorn.com/foo.jpg').pipe(fs.createWriteStream('dist/foo.jpg'));
 
Promise.all([
    'unicorn.com/foo.jpg',
    'cats.com/dancing.gif'
].map(x => download(x, 'dist'))).then(() => {
    console.log('files downloaded!');
});

API

download(url, [destination], [options])

Returns both a Promise<Buffer> and a Duplex stream with additional events.

url

Type: string

URL to download.

destination

Type: string

Path to where your file will be written.

options

Same options as got in addition to the ones below.

extract

Type: boolean
Default: false

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

filename

Type: string

Name of the saved file.

proxy

Type: string

Proxy endpoint.

License

MIT © Kevin Mårtensson

Private packages for the whole team

It’s never been easier to manage developer teams with varying permissions and multiple projects. Learn more about Private Packages and Organizations…

how? learn more

Collaborators list

Stats

Try it out

Keywords

download, extract, http, request, url

Dependencies (11)

caw, content-disposition, decompress, ext-name, file-type, filenamify, get-stream, got, make-dir, p-event, pify

Dependents (401)

go-semantic-release, slate-cli, elm-format-download, napa, yicon-builder, podcast-feed, generator-sf, brandai-cli, faxx, oppm, @journeyapps/serverless, sonarqube-scanner, mlab-audio, generator-buildabanner, insales-uploader, fieldbook-download, kindlegen, react-native-logentries, libgrabber, merino, ppt-markdown-yr, StanLee-WPTheme-Generator, 10.16yangrantest, p5-manager, big-bertha, archr, chromiup, arcanist, nimble-cli, thresher, node-nightly, steroids, generator-origin-craft, loopin-native, weex-buildtool, client-hooks-mvn-compile, client-hooks-gulp-eslint, soprano-saxophone-temp, molphylo, generator-cpm-product, any2api-util, flex-sdk-provider, bot-marvin, yeoman-remote, appveyor-runner, 40dev-tools, f3js-cli, node-isimulator, download-github-repo, yuan-console, and more