node-zip

node-zip - Zip/Unzip files ported from JSZip

Installation

1npm install node-zip

Usage

Complete example, zip multiple files

1var fs = require('fs');
2var path = require('path');
3
4// The zip library needs to be instantiated:
5var zip = new require('node-zip')();
6
7// You can add multiple files by performing subsequent calls to zip.file();
8// the first argument is how you want the file to be named inside your zip,
9// the second is the actual data:
10zip.file('file1.txt', fs.readFileSync(path.join(__dirname, 'file1.txt')));
11zip.file('file2.txt', fs.readFileSync(path.join(__dirname, 'file2.txt')));
12
13var data = zip.generate({ base64:false, compression: 'DEFLATE' });
14
15// it's important to use *binary* encode
16fs.writeFileSync('test.zip', data, 'binary');

---

You can also load directly:

1require('node-zip');
2var zip = new JSZip(data, options)
3    ...

Zip text into file:

1var zip = new require('node-zip')();
2
3zip.file('test.file', 'hello there');
4var data = zip.generate({base64:false,compression:'DEFLATE'});
5console.log(data); // ugly data

Unzip:

1var zip = new require('node-zip')(data, {base64: false, checkCRC32: true});
2console.log(zip.files['test.file']); // hello there

Write to a file (IMPORTANT: use binary encode, thanks to @Acek)

1var fs = require("fs");
2zip.file('test.txt', 'hello there');
3var data = zip.generate({base64:false,compression:'DEFLATE'});
4fs.writeFileSync('test.zip', data, 'binary');

Testing

1npm install -g jasmine-node
2jasmine-node test

Manual

node-zip uses JSZip, please refer to their website for further information: http://stuartk.com/jszip/

Contributors

David Duponchel @dduponchel

Feel free to send your pull requests and contribute to this project

License

MIT