decompress ![Build Status](https://travis-ci.org/kevva/decompress.svg?branch=master)
Easily extract .zip
, .tar
and .tar.gz
archives
Install
$ npm install --save decompress
Usage
You'll only need to pass a type into ext
and it'll figure the rest out for
you.
var decompress = require('decompress');
var fs = require('fs');
fs.createReadStream('foo.tar.gz').pipe(decompress({ ext: '.tar.gz' }));
API
decompress(opts)
Extract an archive using the ext
option to determine which extractor to use.
If no path
is specified it'll extract it to your current location.
Determine if a file can be extracted or not by checking the file extension
and/or the MIME type.
decompress.canExtract('foo.zip');
decompress.canExtract('application/zip');
Options
ext
Type: String
Default: ''
String that can be a file name, URL, MIME type etc.
path
Type: String
Default: process.cwd()
Path to extract the archive to. If no path
is defined it'll extract it to your
current location.
strip
Type: Number
Default: 0
Equivalent to --strip-components
for tar.
CLI
$ npm install --global decompress
$ decompress --help
Usage
$ decompress <file>
$ cat <file> | decompress
Example
$ decompress --out dist --strip 1 archive.zip
$ cat files.txt | decompress --out dist
Options
-o, --out <path> Path to extract the archive to
-s, --strip <number> Strip path segments from root when extracting
License
MIT © Kevin Mårtensson