Skip to content

Commit effbabb

Browse files
committed
Update docs
1 parent 2b2ef87 commit effbabb

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ Emulates Node's [zlib](http://nodejs.org/api/zlib.html) module for [Browserify](
44
using [pako](https://github.com/nodeca/pako). It uses the actual Node source code and passes the Node zlib tests
55
by emulating the C++ binding that actually calls zlib.
66

7+
## Not implemented
8+
9+
The following options/methods are not supported because pako does not support them yet.
10+
11+
* The `params` method
12+
* The `dictionary` option
13+
714
## License
815

916
MIT

src/binding.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ exports.DEFLATERAW = 5;
1818
exports.INFLATERAW = 6;
1919
exports.UNZIP = 7;
2020

21+
/**
22+
* Emulate Node's zlib C++ layer for use by the JS layer in index.js
23+
*/
2124
function Zlib(mode) {
2225
if (mode < exports.DEFLATE || mode > exports.UNZIP)
2326
throw new TypeError("Bad argument");

0 commit comments

Comments
 (0)