Socket
Socket
Sign inDemoInstall

download

Package Overview
Dependencies
61
Maintainers
1
Versions
70
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    download

Download and extract files effortlessly


Version published
Weekly downloads
2M
increased by0.24%
Maintainers
1
Created
Weekly downloads
 

Package description

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

Readme

Source

download Build Status

Download and extract files effortlessly in Node.js.

Getting started

Install with npm: npm install download

Examples

If you're fetching an archive you can set extract: true in options and it'll extract it for you.

var download = require('download');

// download and extract `foo.tar.gz` into `bar/`
download('foo.tar.gz', 'bar', { extract: true });

// download and save `foo.exe` into `bar/foo.exe` with mode `0755`
download('foo.exe', 'bar', { mode: '0755' });

// download and save an array of files in `bar/`
var files = ['foo.jpg', 'bar.jpg', 'cat.jpg'];
download(files, 'bar');

API

download(url, dest, opts)

Download a file or an array of files to a given destination. Returns an EventEmitter with three possible events — response, data and error.

Options

  • extract — If set to true, try extracting the file using decompress
  • mode — Set mode on the downloaded files
  • strip — Equivalent to --strip-components for tar

You can also define options accepted by the request module.

License

MIT License (c) Kevin Mårtensson

Keywords

FAQs

Last updated on 18 Dec 2013

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc