decompress

Easily extract .zip, .tar and .tar.gz archives. Based on the extract utility in Bower.

Install

npm install --save decompress

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' }));

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');
// => true

decompress.canExtract('application/zip');
// => true

Type: String
Default: ''

String that can be a file name, URL, MIME type etc.

Type: String
Default: process.cwd()

Path to extract the archive to. If no path is defined it'll extract it to your current location.

Type: Number
Default: 0

Equivalent to --strip-components for tar.