Skip to content

make archive process explicit #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0x70b1a5 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

make archive process explicit #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,12 @@ var fs = require('fs');
var path = require('path');

// The zip library needs to be instantiated:
var zip = new require('node-zip')();
var JSZip = require('node-zip');

// call the constructor to create a new zip archive in-memory.
// all subsequent calls to zip will be put into this file.
// if you want to create multiple archives, you will need to create another object.
var zip = new JSZip();

// You can add multiple files by performing subsequent calls to zip.file();
// the first argument is how you want the file to be named inside your zip,
Expand All @@ -46,8 +51,10 @@ var zip = new JSZip(data, options)
### Zip text into file:

```js
var zip = new require('node-zip')();
var JSZip = require('node-zip');

// call the constructor to create a new zip archive in-memory
var zip = new JSZip();
zip.file('test.file', 'hello there');
var data = zip.generate({base64:false,compression:'DEFLATE'});
console.log(data); // ugly data
Expand All @@ -56,7 +63,8 @@ console.log(data); // ugly data
### Unzip:

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

Expand Down Expand Up @@ -88,4 +96,4 @@ Feel free to send your pull requests and contribute to this project

## License

MIT
MIT