diff options
| author | Andreas Girgensohn <andreasg@fxpal.com> | 2018-08-15 23:03:15 -0700 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-08-18 11:21:51 +0300 |
| commit | 44d04a8c01dba1d7e4a9c9d9a4415eeacc580bf4 (patch) | |
| tree | 8916e8a4ca8cc00b88cc0f1de76ee9f3a12705f3 /doc/api/zlib.md | |
| parent | 9d6619efeaa80f899d0ee06ddb37c6c76e41f823 (diff) | |
| download | android-node-v8-44d04a8c01dba1d7e4a9c9d9a4415eeacc580bf4.tar.gz android-node-v8-44d04a8c01dba1d7e4a9c9d9a4415eeacc580bf4.tar.bz2 android-node-v8-44d04a8c01dba1d7e4a9c9d9a4415eeacc580bf4.zip | |
doc: clarify documentation of pipes and zlib objects
Document how pipes can be chained in readable.pipe().
Document that zlib.Zlib inherits from stream.Transform.
PR-URL: https://github.com/nodejs/node/pull/22354
Fixes: https://github.com/nodejs/node/issues/22341
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/zlib.md')
| -rw-r--r-- | doc/api/zlib.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/zlib.md b/doc/api/zlib.md index 746058f5a3..8ec179ba4a 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -397,6 +397,9 @@ added: v0.5.8 Not exported by the `zlib` module. It is documented here because it is the base class of the compressor/decompressor classes. +This class inherits from [`stream.Transform`][], allowing `zlib` objects to be +used in pipes and similar stream operations. + ### zlib.bytesRead <!-- YAML added: v8.1.0 @@ -840,6 +843,7 @@ Decompress a chunk of data with [`Unzip`][]. [`InflateRaw`]: #zlib_class_zlib_inflateraw [`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray [`Unzip`]: #zlib_class_zlib_unzip +[`stream.Transform`]: stream.html#stream_class_stream_transform [`zlib.bytesWritten`]: #zlib_zlib_byteswritten [Memory Usage Tuning]: #zlib_memory_usage_tuning [pool size]: cli.html#cli_uv_threadpool_size_size |