Skip to content

Doc: stream becomes paused after unpipe. #5156

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
iliakan wants to merge 4 commits into from
Closed

Doc: stream becomes paused after unpipe. #5156

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6db6af8
Update stream.markdown
iliakan Feb 9, 2016
1a1a0f9
Update stream.markdown
iliakan Feb 9, 2016
7e2732b
Update stream.markdown
iliakan Feb 9, 2016
5f6f6fd
Update stream.markdown
iliakan Apr 22, 2016
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
Next Next commit
Update stream.markdown
  • Loading branch information
@iliakan
iliakan committed Feb 9, 2016
commit 1a1a0f92ebafdb9fdc2bbd27cb29b1c4463e1d26
10 changes: 6 additions & 4 deletions doc/api/stream.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,11 +256,13 @@ end

* Return: `Boolean`

This method returns whether or not the `readable` has been **explicitly**
paused by client code (using [`stream.pause()`][stream-pause] without a
corresponding [`stream.resume()`][stream-resume]).
This method returns whether or not the `readable` has been paused by client code including the following cases:

The `unpipe` call also makes the stream paused.
* If there are no pipe destinations, by calling the
[`stream.pause()`][stream-pause] method.
* If there are pipe destinations, by removing any [`'data'`][] event
Copy link
Copy Markdown
Member

@mcollina mcollina Apr 29, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

all 'data' event handlers? Please check.

handlers, and removing all pipe destinations by calling the
[`stream.unpipe()`][] method.

```js
var readable = new stream.Readable
Expand Down