extract-zip

WebJar for extract-zip

License

License

BSD 2-Clause
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

extract-zip
Last Version

Last Version

2.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

extract-zip
WebJar for extract-zip
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/maxogden/extract-zip

Download extract-zip

How to add to project

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

Dependencies

compile (4)

Group / Artifact Type Version
org.webjars.npm : debug jar [4.1.1,5)
org.webjars.npm : get-stream jar [5.1.0,6)
org.webjars.npm : yauzl jar [2.10.0,3)
org.webjars.npm » types__yauzl Optional jar [2.9.1,3)

Project Modules

There are no modules declared in this project.

extract-zip

Unzip written in pure JavaScript. Extracts a zip into a directory. Available as a library or a command line program.

Uses the yauzl ZIP parser.

NPM Uses JS Standard Style Build Status

Installation

Make sure you have Node 10 or greater installed.

Get the library:

npm install extract-zip --save

Install the command line program:

npm install extract-zip -g

JS API

const extract = require('extract-zip')

async function main () {
  try {
    await extract(source, { dir: target })
    console.log('Extraction complete')
  } catch (err) {
    // handle any errors
  }
}

Options

  • dir (required) - the path to the directory where the extracted files are written
  • defaultDirMode - integer - Directory Mode (permissions), defaults to 0o755
  • defaultFileMode - integer - File Mode (permissions), defaults to 0o644
  • onEntry - function - if present, will be called with (entry, zipfile), entry is every entry from the zip file forwarded from the entry event from yauzl. zipfile is the yauzl instance

Default modes are only used if no permissions are set in the zip file.

CLI Usage

extract-zip foo.zip <targetDirectory>

If not specified, targetDirectory will default to process.cwd().

Versions

Version
2.0.1
1.7.0
1.6.7
1.6.6
1.5.0