diff options
| author | isaacs <i@izs.me> | 2013-03-08 07:55:45 -0800 |
|---|---|---|
| committer | isaacs <i@izs.me> | 2013-03-08 18:56:31 -0800 |
| commit | b3cbb16f41f3a7dfdbe9ad087ef9465b30529b09 (patch) | |
| tree | c593b8687a21819d72eb5d0f1af86a1b348a569f /doc | |
| parent | 29cd0f2a77faa3b2a746e64e4871cded32e8aa98 (diff) | |
| download | node-new-b3cbb16f41f3a7dfdbe9ad087ef9465b30529b09.tar.gz | |
zlib: Manage flush flags appropriately
If you call z.flush();z.write('foo'); then it would try to write 'foo'
before the flush was done, triggering an assertion in the zlib binding.
Closes #4950
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/zlib.markdown | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/api/zlib.markdown b/doc/api/zlib.markdown index 5dcde32489..6a194b9e11 100644 --- a/doc/api/zlib.markdown +++ b/doc/api/zlib.markdown @@ -228,9 +228,10 @@ Decompress a raw Buffer with Unzip. Each class takes an options object. All options are optional. (The convenience methods use the default settings for all options.) -Note that some options are only -relevant when compressing, and are ignored by the decompression classes. +Note that some options are only relevant when compressing, and are +ignored by the decompression classes. +* flush (default: `zlib.Z_NO_FLUSH`) * chunkSize (default: 16*1024) * windowBits * level (compression only) @@ -238,8 +239,8 @@ relevant when compressing, and are ignored by the decompression classes. * strategy (compression only) * dictionary (deflate/inflate only, empty dictionary by default) -See the description of `deflateInit2` and `inflateInit2` -at <http://zlib.net/manual.html#Advanced> for more information on these. +See the description of `deflateInit2` and `inflateInit2` at +<http://zlib.net/manual.html#Advanced> for more information on these. ## Memory Usage Tuning |