diff options
| -rw-r--r-- | doc/api/stream.md | 4 | ||||
| -rw-r--r-- | doc/api/zlib.md | 4 |
2 files changed, 6 insertions, 2 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 578a1cd140..c42df4ee7c 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -895,8 +895,8 @@ added: v0.9.4 * `destination` {stream.Writable} The destination for writing data * `options` {Object} Pipe options * `end` {boolean} End the writer when the reader ends. **Default:** `true`. -* Returns: {stream.Writable} making it possible to set up chains of piped - streams +* Returns: {stream.Writable} The *destination*, allowing for a chain of pipes if + it is a [`Duplex`][] or a [`Transform`][] stream The `readable.pipe()` method attaches a [`Writable`][] stream to the `readable`, causing it to switch automatically into flowing mode and push all of its data 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 |