untar-request/readme.md

A utility for ungzipping and untaring a file directly from a url while it is being downloaded

[![bitHound Score](https://www.bithound.io/github/noodny/untar-request/badges/score.svg)](https://www.bithound.io/github/noodny/untar-request)
[![npm](https://img.shields.io/npm/v/untar-request.svg)](https://www.npmjs.com/package/untar-request)

### About
This module allows you to download a `.tar.gz` archive from a url, and decompress it on the fly by utilizing nodejs
streams, finally writing it to a selected directory.

### Usage

```
var untarRequest = require('untar-request');

var options = {
     url: 'http://example.com/some-archive.tar.gz',
     dest: './'
}

untarRequest(options, function() {
    console.log('done');
});
```

You may want to use `options.dmode` and `options.fmode` to set appropriate access modes for directories and files, e.g.:
```
var options = {
     url: 'http://example.com/some-archive.tar.gz',
     dest: './',
     dmode: 0555,
     fmode: 0444
}
```