download-tarball

download-tarball

Download a tarball (optionally gzipped) to a folder & extract it in the process. Uses the wonderful & super quick tar-fs & gunzip-maybe libraries.

Installation

Download node at nodejs.org and install it, if you haven't already.

npm install download-tarball --save

Usage

/* eslint-disable import/no-extraneous-dependencies */

import download from 'download-tarball';

download({
  url: 'http://link-to-tarball/file.tar.gz',
  dir: '/dir/where/file/will/be/downloaded'
}).then(() => {
  console.log('file is now downloaded!');
}).catch(err => {
  console.log('oh crap the file could not be downloaded properly');
  console.log(err);
});

download({
  url: 'http://link-to-tarball/file.tar.gz',
  dir: '/dir/where/file/will/be/downloaded',
  // custom options that will be forwarded to got.stream(..., opts) can also be set
  gotOpts: {
    headers: {
      beep: 'boop'
    }
  }
}).then(() => {
  console.log('file is now downloaded!');
}).catch(err => {
  console.log('oh crap the file could not be downloaded properly');
  console.log(err);
});

download({
  // neat, tar files works as well!
  url: 'http://link-to-tarball/file.tar',
  dir: '/dir/where/file/will/be/downloaded'
}).then(() => {
  console.log('file is now downloaded!');
}).catch(err => {
  console.log('oh crap the file could not be downloaded properly');
  console.log(err);
});

Tests

npm install
npm test

Dependencies

• bluebird: Full featured Promises/A+ implementation with exceptionally good performance
• got: Simplified HTTP requests
• gunzip-maybe: Transform stream that gunzips its input if it is gzipped and just echoes it if not
• http-https-agent: Get either a HTTP or HTTPS agent depending on protocol
• object-assign: ES2015 Object.assign() ponyfill
• pump: pipe streams together and close all of them if one of them closes
• tar-fs: filesystem bindings for tar-stream

Dev Dependencies

• babel-cli: Babel command line.
• babel-core: Babel compiler core.
• babel-preset-es2015: Babel preset for all es2015 plugins.
• babel-tape-runner: Babel + Tape for running your ES Next tests
• http-test-server: Create a simple http server for tests
• package-json-to-readme: Generate a README.md from package.json contents
• tapava: the syntax of ava, run through tape
• tar-stream: tar-stream is a streaming tar parser and generator and nothing else. It is streams2 and operates purely using streams which means you can easily extract/parse tarballs without ever hitting the file system.
• then-fs: promised FS
• tmp: Temporary file and directory creator
• xo: JavaScript happiness style linter ❤️

License

MIT

Generated by package-json-to-readme