diff --git a/doc/api/zlib.markdown b/doc/api/zlib.markdown index 92f3f5e52c..87d469436d 100644 --- a/doc/api/zlib.markdown +++ b/doc/api/zlib.markdown @@ -308,6 +308,11 @@ class of the compressor/decompressor classes. Flush pending data. Don't call this frivolously, premature flushes negatively impact the effectiveness of the compression algorithm. +Calling this only flushes data from the internal zlib state, and does not +perform flushing of any kind on the streams level. Rather, it behaves like a +normal call to `.write()`, i.e. it will be queued up behind other pending +writes and will only produce output when data is being read from the stream. + ### zlib.params(level, strategy, callback) Dynamically update the compression level and compression strategy.