diff options
| author | Ben Noordhuis <info@bnoordhuis.nl> | 2012-09-19 13:22:27 +0200 |
|---|---|---|
| committer | Ben Noordhuis <info@bnoordhuis.nl> | 2012-09-19 13:22:29 +0200 |
| commit | c4aedf8a2adc3b17254a8f6233733630d0b0a64c (patch) | |
| tree | 8a1f2873603b2716134eebb0afb4ee75533a6178 | |
| parent | 63ff449d87e23b5e3d475da960135c1a2fd0ed58 (diff) | |
| download | node-c4aedf8a2adc3b17254a8f6233733630d0b0a64c.tar.gz | |
doc: zlib: document flush() and reset() methods
| -rw-r--r-- | doc/api/zlib.markdown | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/api/zlib.markdown b/doc/api/zlib.markdown index 66c928460..5dcde3248 100644 --- a/doc/api/zlib.markdown +++ b/doc/api/zlib.markdown @@ -139,6 +139,21 @@ Returns a new [Unzip](#zlib_class_zlib_unzip) object with an [options](#zlib_options). +## Class: zlib.Zlib + +Not exported by the `zlib` module. It is documented here because it is the base +class of the compressor/decompressor classes. + +### zlib.flush(callback) + +Flush pending data. Don't call this frivolously, premature flushes negatively +impact the effectiveness of the compression algorithm. + +### zlib.reset() + +Reset the compressor/decompressor to factory defaults. Only applicable to +the inflate and deflate algorithms. + ## Class: zlib.Gzip Compress data using gzip. |