Skip to content
Extracting archives made easy
JavaScript
Latest commit 7b32db0 May 24, 2016 @shinnn shinnn committed with Bump strip-dirs to v2.x (#39)

readme.md

decompress Build Status

Extracting archives made easy

See decompress-cli for the command-line version.

Install

$ npm install --save decompress

Usage

const decompress = require('decompress');

decompress('unicorn.zip', 'dist').then(files => {
    console.log('done!');
});

API

decompress(input, [output], [options])

Returns a Promise for an array of files in the following format:

{
    data: Buffer,
    mode: Number,
    mtime: String,
    path: String,
    type: String
}

input

Type: string Buffer

File to decompress.

output

Type: string

Output directory.

options

filter

Type: Function

Filter out files before extracting. E.g:

decompress('unicorn.zip', 'dist', {
    filter: file => path.extname(file.path) !== '.exe'
}).then(files => {
    console.log('done!');
});
map

Type: Function

Map files before extracting: E.g:

decompress('unicorn.zip', 'dist', {
    map: file => {
        file.path = `unicorn-${file.path}`;
        return file;
    }
}).then(files => {
    console.log('done!');
});
plugins

Type: Array
Default: [decompressTar(), decompressTarbz2(), decompressTargz(), decompressUnzip()]

Array of plugins to use.

strip

Type: number
Default: 0

Remove leading directory components from extracted files.

License

MIT © Kevin Mårtensson

Something went wrong with that request. Please try again.