Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Commit

Permalink
doc: zlib: document flush() and reset() methods
Browse files Browse the repository at this point in the history
  • Loading branch information
bnoordhuis committed Sep 19, 2012
1 parent 63ff449 commit c4aedf8
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions doc/api/zlib.markdown
Expand Up @@ -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.
Expand Down

0 comments on commit c4aedf8

Please sign in to comment.