doc: make it more exact - #18375
Closed
MoonBall wants to merge 3 commits into
Closed
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
MoonBall
commented
Jan 25, 2018
Comment thread
doc/api/stream.md
Outdated
| handlers, and removing all pipe destinations by calling the | ||
| [`stream.unpipe()`][] method. | ||
| * If there are pipe destinations, by removing all pipe destinations by | ||
| calling the [`stream.unpipe()`][] method. |
Copy link
Copy Markdown
Member
Author
There was a problem hiding this comment.
only calling unpipe() will make stream to paused mode. see the following example.
const { Readable, Writable } = require('stream');
const r = new Readable();
const w = new Writable();
r._read = () => {};
w._write = () => {};
r.pipe(w);
r.on('data', () => {});
r.unpipe();
console.log(r._readableState.flowing); // the output is false
Sorry, something went wrong.
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
quick grammar nit on this: by removing all pipe destinations by ... the sentence should be something like:
Multiple pipe destinations may be removed by calling the [`stream.unpipe()`][] method.
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
There was a problem hiding this comment.
fixed.
Sorry, something went wrong.
MoonBall
commented
Jan 25, 2018
Comment thread
doc/api/stream.md
Outdated
| buffered. Once the `callback` is invoked, the stream will emit a [`'drain'`][] | ||
| event. If a stream implementation is capable of processing multiple chunks of | ||
| data at once, the `writable._writev()` method should be implemented. | ||
| buffered. When the `callback` is invoked, the stream maybe will emit a |
Copy link
Copy Markdown
Member
Author
There was a problem hiding this comment.
Emitting a 'drain' event need to meet more conditions. See the source code of writable stream.
Sorry, something went wrong.
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
maybe will -> might
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
There was a problem hiding this comment.
fixed.
Sorry, something went wrong.
maclover7
approved these changes
Jan 26, 2018
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
BridgeAR
approved these changes
Jan 31, 2018
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
Feb 1, 2018
PR-URL: nodejs#18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 20, 2018
PR-URL: #18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 21, 2018
PR-URL: #18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 21, 2018
PR-URL: #18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Mar 20, 2018
PR-URL: #18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 28, 2018
PR-URL: #18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 30, 2018
PR-URL: #18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Merged
MayaLekova
pushed a commit
to MayaLekova/node
that referenced
this pull request
May 8, 2018
PR-URL: nodejs#18375 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This file contains hidden or 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
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.
I made a comment on every change.
Checklist
Affected core subsystem(s)
stream