Permalink
Browse files

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

  • Loading branch information...
1 parent 63ff449 commit c4aedf8a2adc3b17254a8f6233733630d0b0a64c @bnoordhuis bnoordhuis committed Sep 19, 2012
Showing with 15 additions and 0 deletions.
  1. +15 −0 doc/api/zlib.markdown
View
@@ -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.

0 comments on commit c4aedf8

Please sign in to comment.