Skip to content

doc/api: clarify the documentation of pipes and zlib objects in them #22354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
andreasg123 wants to merge 3 commits into from
Closed

doc/api: clarify the documentation of pipes and zlib objects in them #22354

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72a9c89
doc/api: clarify the documentation of pipes and zlib objects in them
andreasg123 Aug 16, 2018
669dea8
doc/api: add link reference for stream.Transform
andreasg123 Aug 16, 2018
6729a7a
doc/api: list stream.Transform as another option for pipes
andreasg123 Aug 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
doc/api: list stream.Transform as another option for pipes
  • Loading branch information
@andreasg123
andreasg123 committed Aug 16, 2018
commit 6729a7aa9370af6370a1ed83a8003692e309cd51
2 changes: 1 addition & 1 deletion doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,7 +896,7 @@ added: v0.9.4
* `options` {Object} Pipe options
* `end` {boolean} End the writer when the reader ends. **Default:** `true`.
* Returns: {stream.Writable} The *destination*, allowing for a chain of pipes if
it is a [`Duplex`][] stream
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
Expand Down