From c4aedf8a2adc3b17254a8f6233733630d0b0a64c Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Wed, 19 Sep 2012 13:22:27 +0200 Subject: [PATCH] doc: zlib: document flush() and reset() methods --- doc/api/zlib.markdown | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/api/zlib.markdown b/doc/api/zlib.markdown index 66c92846029..5dcde32489d 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.