Inspect and uncompress zipfile archives in Node.js
C++ JavaScript Python Makefile Shell Batchfile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bench convert benchmark to async copyFile Jan 14, 2015
bin
deps attempt to fix #65 Dec 1, 2015
lib
scripts
src close file handle on error - closes #69 Sep 13, 2016
test fix zf.copyFile test to actually test second buffer against first Apr 18, 2016
tools linting as per google c++ style Nov 8, 2011
.gitignore
.npmignore
.travis.yml start building for node v6, drop v0.12 Sep 13, 2016
CHANGELOG.md
LICENSE.txt port from springmeyer to mapbox Mar 7, 2014
Makefile Fixup makefile Dec 1, 2015
README.md update supported versions in readme [skip ci] Sep 13, 2016
appveyor.yml simplify windows versions Sep 13, 2016
binding.gyp code cleanup Jan 13, 2015
configure support node v0.10.x by migrating to node-gyp build system Aug 10, 2013
package.json bump to v0.5.10 [publish binary] Sep 13, 2016
test.js Minor fixes Mar 7, 2014
vcbuild.bat fixup vcbuild.bat Mar 11, 2014

README.md

node-zipfile

Bindings to libzip for handling zipfile archives in node.

Build Status Build status Dependencies Coverage Status

Example

var zipfile = require('zipfile');

// Creating a zipfile object
var zf = new zipfile.ZipFile('./test/data/world_merc.zip');

// the zipfile has a list of names:
// zf.names[0] === 'world_merc.prj'

// the zipfile also has a count property that is the number of files contained
// zf.count == 2

// finally it has a readFile method that uncompresses a single file
// into a Buffer object
zf.readFile('world_merc.prj', function(err, buffer) {
    if (err) throw err;
    console.log(buffer.toString());
});

Large files

To handle large zipfiles and avoid the overhead of passing data from C++ to JS use the copyFile interface:

var zipfile = require('zipfile');
var zf = new zipfile.ZipFile('./test/data/world_merc.zip');
var zip_entry_name = 'world_merc.shp';
var output_file = 'out/world_merc.shp';
zf.copyFile(zip_entry_name,output_file, function(err) {
  if (err) throw err;
  console.log('Successfully wrote ' + output_file);
});

Depends

  • Node v0.10.x, v4.x, v5.x, or v6.x

Installation

Install from binary:

npm install

Install from source:

npm install --build-from-source

Dynamically linking against libzip

node-zipfile depends on libzip, but by default bundles a copy in deps/ which is statically linked and packaged as a binary.

If you want to use an external libzip first install it:

Debian:

sudo apt-get install libzip-dev libzip1

OS X:

brew install libzip

Then configure node-zipfile with the --shared_libzip option:

npm install  --build-from-source --shared_libzip

If you installed libzip in a custom location then configure like:

npm install  --build-from-source --shared_libzip \
  --shared_libzip_includes=/opt/local/include \
  --shared_libzip_libpath=/opt/local/lib

If you installed libzip with homebrew do:

npm install --build-from-source --shared_libzip \
  --shared_libzip_includes=`brew --prefix`/include \
  --shared_libzip_libpath=`brew --prefix`/lib

License

BSD, see LICENSE.txt