decompress-zip

WebJar for decompress-zip

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

decompress-zip
Last Version

Last Version

0.3.0
Release Date

Release Date

Type

Type

jar
Description

Description

decompress-zip
WebJar for decompress-zip
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/bower/decompress-zip

Download decompress-zip

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/decompress-zip/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>decompress-zip</artifactId>
    <version>0.3.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/decompress-zip/
implementation 'org.webjars.npm:decompress-zip:0.3.0'
// https://jarcasting.com/artifacts/org.webjars.npm/decompress-zip/
implementation ("org.webjars.npm:decompress-zip:0.3.0")
'org.webjars.npm:decompress-zip:jar:0.3.0'
<dependency org="org.webjars.npm" name="decompress-zip" rev="0.3.0">
  <artifact name="decompress-zip" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='decompress-zip', version='0.3.0')
)
libraryDependencies += "org.webjars.npm" % "decompress-zip" % "0.3.0"
[org.webjars.npm/decompress-zip "0.3.0"]

Dependencies

compile (7)

Group / Artifact Type Version
org.webjars.npm : mkpath jar [0.1.0,0.2)
org.webjars.npm : q jar [1.1.2,2)
org.webjars.npm : binary jar [0.3.0,0.4)
org.webjars.npm : graceful-fs jar [4.1.3,5)
org.webjars.npm : readable-stream jar [1.1.8,2)
org.webjars.npm : nopt jar [3.0.1,4)
org.webjars.npm : touch jar 0.0.3

Project Modules

There are no modules declared in this project.

decompress-zip Build Status Coverage Status

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)
var DecompressZip = require('decompress-zip');
var unzipper = new DecompressZip(filename)

unzipper.on('error', function (err) {
    console.log('Caught an error');
});

unzipper.on('extract', function (log) {
    console.log('Finished extracting');
});

unzipper.on('progress', function (fileIndex, fileCount) {
    console.log('Extracted file ' + (fileIndex + 1) + ' of ' + fileCount);
});

unzipper.extract({
    path: 'some/path',
    filter: function (file) {
        return file.type !== "SymbolicLink";
    }
});

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
var DecompressZip = require('decompress-zip');
var unzipper = new DecompressZip(filename)

unzipper.on('error', function (err) {
    console.log('Caught an error');
});

unzipper.on('list', function (files) {
    console.log('The archive contains:');
    console.log(files);
});

unzipper.list();

License

MIT © Bower team

org.webjars.npm

Bower

A package manager for the web

Versions

Version
0.3.0