Popularity
3.6
Growing
Activity
0.0
Stable
275
8
29

Code Quality Rank: L5
Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Compression     Unzip     Zip     Tar.gz     Tar.bz     Tar     Extract     Decompress     Bzip2     Bz2    
Latest version: v4.2.0

decompress alternatives and similar modules

Based on the "Compression" category

Do you think we are missing an alternative of decompress or a related project?

Add another 'Compression' Module

README

decompress Build Status

Extracting archives made easy

See decompress-cli for the command-line version.

Install

$ npm install 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!');
});

Note that in the current implementation, *filter is only applied after fully reading all files from the archive in memory*. Do not rely on this option to limit the amount of memory used by decompress to the size of the files included by filter. decompress will read the entire compressed file into memory regardless.

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


*Note that all licence references and agreements mentioned in the decompress README section above are relevant to that project's source code only.