Skip to content

Commit

Permalink
doc: improve stream documentation
Browse files Browse the repository at this point in the history
PR-URL: #18375
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
陈刚 authored and MylesBorins committed Feb 21, 2018
1 parent d469a06 commit 74a823c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -580,8 +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
* If there are pipe destinations, by removing all pipe destinations.
Multiple pipe destinations may be removed by calling the
[`stream.unpipe()`][] method.

The important concept to remember is that a Readable will not generate data
Expand Down Expand Up @@ -1428,7 +1428,7 @@ 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'`][]
buffered. When the `callback` is invoked, the stream might 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.

Expand Down

0 comments on commit 74a823c

Please sign in to comment.