decompress-zip

Extract files from a ZIP archive

Usage

.extract(options)

Extracts the contents of the ZIP archive file.

Returns an EventEmitter with two possible events - error on an error, and extract when the extraction has completed. The value passed to the extract event is a basic log of each file and how it was compressed.

Options

• path String - Path to extract into (default .)
• follow Boolean - If true, rather than create stored symlinks as symlinks make a shallow copy of the target instead (default false)
• filter Function - A function that will be called once for each file in the archive. It takes one argument which is an object containing details of the file. Return true for any file that you want to extract, and false otherwise. (default null)
• strip Number - Remove leading folders in the path structure. Equivalent to --strip-components for tar.
• restrict Boolean - If true, will restrict files from being created outside options.path. Setting to false has significant security implications if you are extracting untrusted data. (default true)

1var DecompressZip = require('decompress-zip');
2var unzipper = new DecompressZip(filename)
3
4unzipper.on('error', function (err) {
5    console.log('Caught an error');
6});
7
8unzipper.on('extract', function (log) {
9    console.log('Finished extracting');
10});
11
12unzipper.on('progress', function (fileIndex, fileCount) {
13    console.log('Extracted file ' + (fileIndex + 1) + ' of ' + fileCount);
14});
15
16unzipper.extract({
17    path: 'some/path',
18    filter: function (file) {
19        return file.type !== "SymbolicLink";
20    }
21});

If path does not exist, decompress-zip will attempt to create it first.

.list()

Much like extract, except:

• the success event is list
• the data for the event is an array of paths
• no files are actually extracted
• there are no options

1var DecompressZip = require('decompress-zip');
2var unzipper = new DecompressZip(filename)
3
4unzipper.on('error', function (err) {
5    console.log('Caught an error');
6});
7
8unzipper.on('list', function (files) {
9    console.log('The archive contains:');
10    console.log(files);
11});
12
13unzipper.list();

License

MIT © Bower team