Skip to content
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

doc: make it more exact #18375

Closed
wants to merge 3 commits into from
Closed

doc: make it more exact #18375

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2797b86
doc: make it more exact
Jan 25, 2018
2485350
Modify `maybe will` to `might`
Jan 26, 2018
178c55b
Fixed grammar nit
Jan 27, 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
12 changes: 6 additions & 6 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,9 +580,8 @@ The Readable can switch back to paused mode using one of the following:

* If there are no pipe destinations, by calling the
[`stream.pause()`][stream-pause] method.
* If there are pipe destinations, by removing any [`'data'`][] event
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
Member Author

@MoonBall MoonBall Jan 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.


The important concept to remember is that a Readable will not generate data
until a mechanism for either consuming or ignoring that data is provided. If
Expand Down Expand Up @@ -1459,9 +1458,10 @@ write succeeded.

All calls to `writable.write()` that occur between the time `writable._write()`
is called and the `callback` is called will cause the written data to be
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
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Emitting a 'drain' event need to meet more conditions. See the source code of writable stream.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe will -> might

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

[`'drain'`][] event. If a stream implementation is capable of processing
multiple chunks of data at once, the `writable._writev()` method should be
implemented.

If the `decodeStrings` property is set in the constructor options, then
`chunk` may be a string rather than a Buffer, and `encoding` will
Expand Down