doc,stream: clarify 'data', pipe() and 'readable' #13432
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We stated that 'data' and pipe() are preferred over 'readable'. This commit clarifies that 'data' and pipe() are easier to understand, but 'readable' might result in increased throughput. Fixes: nodejs#11587
nodejs-github-bot
added
doc
|
cc @nodejs/streams |
addaleax
approved these changes
Jun 3, 2017
tniessen
approved these changes
Jun 3, 2017
lpinca
approved these changes
Jun 3, 2017
Trott
reviewed
Jun 3, 2017
| @@ -754,7 +754,8 @@ end | |||
| ``` | |||
|
|
|||
| *Note*: In general, the `readable.pipe()` and `'data'` event mechanisms are | |||
| preferred over the use of the `'readable'` event. | |||
| easier to understand compared to the `'readable'` event. | |||
Trott
approved these changes
Jun 3, 2017
|
Landed as 5ca836c. |
mcollina
added a commit
to mcollina/node
that referenced
this pull request
Jun 5, 2017
We stated that 'data' and pipe() are preferred over 'readable'. This commit clarifies that 'data' and pipe() are easier to understand, but 'readable' might result in increased throughput. Fixes: nodejs#11587 PR-URL: nodejs#13432 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
jasnell
pushed a commit
that referenced
this pull request
Jun 5, 2017
We stated that 'data' and pipe() are preferred over 'readable'. This commit clarifies that 'data' and pipe() are easier to understand, but 'readable' might result in increased throughput. Fixes: #11587 PR-URL: #13432 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Closed
3 tasks
MylesBorins
pushed a commit
that referenced
this pull request
Jul 17, 2017
We stated that 'data' and pipe() are preferred over 'readable'. This commit clarifies that 'data' and pipe() are easier to understand, but 'readable' might result in increased throughput. Fixes: #11587 PR-URL: #13432 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
|
I've landed this in v6.x... please let me know if it should be backed out |
|
@MylesBorins this is ok to be backported. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We stated that 'data' and pipe() are preferred over 'readable'.
This commit clarifies that 'data' and pipe() are easier to understand,
but 'readable' might result in increased throughput.
Fixes: #11587
Checklist
Affected core subsystem(s)
doc, stream