Commit d86e615
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: #22354
Fixes: #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>1 parent e644088 commit d86e615
2 files changed
Lines changed: 6 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -895,8 +895,8 @@ added: v0.9.4 | |||
| 895 | 895 | * `destination` {stream.Writable} The destination for writing data | |
| 896 | 896 | * `options` {Object} Pipe options | |
| 897 | 897 | * `end` {boolean} End the writer when the reader ends. **Default:** `true`. | |
| 898 | - * Returns: {stream.Writable} making it possible to set up chains of piped | ||
| 899 | - streams | ||
| 898 | + * Returns: {stream.Writable} The *destination*, allowing for a chain of pipes if | ||
| 899 | + it is a [`Duplex`][] or a [`Transform`][] stream | ||
| 900 | 900 | ||
| 901 | 901 | The `readable.pipe()` method attaches a [`Writable`][] stream to the `readable`, | |
| 902 | 902 | causing it to switch automatically into flowing mode and push all of its data | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -397,6 +397,9 @@ added: v0.5.8 | |||
| 397 | 397 | Not exported by the `zlib` module. It is documented here because it is the base | |
| 398 | 398 | class of the compressor/decompressor classes. | |
| 399 | 399 | ||
| 400 | + This class inherits from [`stream.Transform`][], allowing `zlib` objects to be | ||
| 401 | + used in pipes and similar stream operations. | ||
| 402 | + | ||
| 400 | 403 | ### zlib.bytesRead | |
| 401 | 404 | <!-- YAML | |
| 402 | 405 | added: v8.1.0 | |
@@ -840,6 +843,7 @@ Decompress a chunk of data with [`Unzip`][]. | |||
| 840 | 843 | [`InflateRaw`]: #zlib_class_zlib_inflateraw | |
| 841 | 844 | [`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | |
| 842 | 845 | [`Unzip`]: #zlib_class_zlib_unzip | |
| 846 | + [`stream.Transform`]: stream.html#stream_class_stream_transform | ||
| 843 | 847 | [`zlib.bytesWritten`]: #zlib_zlib_byteswritten | |
| 844 | 848 | [Memory Usage Tuning]: #zlib_memory_usage_tuning | |
| 845 | 849 | [pool size]: cli.html#cli_uv_threadpool_size_size | |
0 commit comments