minizip-asm.js

 

Minizip in javascript. Work with password. Demo: https://rf00.github.io/minizip-asm.js/example/

Features

* Zip file
* Extract file
* Work with password

Installation

``html

`

`js
npm install minizip-asm.js

var Minizip = require('minizip-asm.js');
`

Getting started

`js
var fs = require("fs");

var text = new Buffer("Abc~~~");
var mz = new Minizip();

mz.append("haha/abc.txt", text, {password: "~~~"});
fs.writeFileSync("abc.zip", new Buffer(mz.zip()));
`

Usage

$3

Constructor for making a new zip file or opening from existing one.

* @ArrayBuffer {Buffer|Uint8Array} \ - It can be either Node.js Buffer read from zip file or Uint8Array in web browser.

* @ Return an instance of Minizip.

$3

List all files in Minizip with full filepath and have password or not.

* @options \

* @encoding {"utf8"|"buffer"} \ - Since the filepath may not encode in utf8. It will be handy to have an ArrayBuffer to do detection on encoding.

* @ Return an Array. Something like this:

`js
[{
filepath: "haha/abc.txt",
crypt: true // (type: boolean)
}]
`

$3

Extract one file.

* @filepath {String|Buffer|Uint8Array} - Full filepath to extract.

* @options \

* @encoding {"utf8"|"buffer"} \ - File can return in text.

* @password {String|Buffer|Uint8Array} \

* @ Return a Buffer.

$3

Append one file.

* @filepath {String|Buffer|Uint8Array} - Full filepath to extract.

* @data {String|Buffer|Uint8Array} - File data.

* @options \

* @password {String|Buffer|Uint8Array} \

* @compressLevel {Number} \ - 0: Store only. 1: Compress faster. 9: Compress better.

* @ Return nothing.

$3

Retrive zip file.

* @ Return a Buffer`.

Notice

1. It is synchronize.
2. The size of minizip-asm.min.js is around 0.6MB.
3. Browser require >= IE11.