Browse Source

doc: zlib: document flush() and reset() methods

v0.9.3-release
Ben Noordhuis 12 years ago
parent
commit
c4aedf8a2a
  1. 15
      doc/api/zlib.markdown

15
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.

Loading…
Cancel
Save