Skip to content

Commit c4aedf8

Browse files
committed
doc: zlib: document flush() and reset() methods
1 parent 63ff449 commit c4aedf8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/api/zlib.markdown

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,21 @@ Returns a new [Unzip](#zlib_class_zlib_unzip) object with an
139139
[options](#zlib_options).
140140

141141

142+
## Class: zlib.Zlib
143+
144+
Not exported by the `zlib` module. It is documented here because it is the base
145+
class of the compressor/decompressor classes.
146+
147+
### zlib.flush(callback)
148+
149+
Flush pending data. Don't call this frivolously, premature flushes negatively
150+
impact the effectiveness of the compression algorithm.
151+
152+
### zlib.reset()
153+
154+
Reset the compressor/decompressor to factory defaults. Only applicable to
155+
the inflate and deflate algorithms.
156+
142157
## Class: zlib.Gzip
143158

144159
Compress data using gzip.

0 commit comments

Comments
 (0)