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.

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: stream state after unpipe is undocumented #4812

Closed
ronkorving opened this issue Jan 22, 2016 · 4 comments
Closed

doc: stream state after unpipe is undocumented #4812

ronkorving opened this issue Jan 22, 2016 · 4 comments
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.

Comments

@ronkorving
Copy link
Contributor

The documentation doesn't mention whether unpipe leaves the stream in flowing mode, or whether a manual resume is needed. If it could mention that, I think that would be helpful. It would also be good to clarify under which circumstances (eg: always vs. when the last pipe has been removed vs. as-long-as-there-are-data-listeners etc...).

@mscdex mscdex added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Jan 22, 2016
@sam-github sam-github added doc Issues and PRs related to the documentations. and removed doc Issues and PRs related to the documentations. docs-requested labels Dec 1, 2016
@Trott
Copy link
Member

Trott commented May 27, 2017

@ronkorving @nodejs/documentation Does this material in the docs adequately address this?

The Readable can switch back to paused mode using one of the following:

  • If there are no pipe destinations, by calling the 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.

@Trott
Copy link
Member

Trott commented May 27, 2017

Oh, there's this too. Not sure this addresses the issue here or not. Does it?

Calling readable.pause(), readable.unpipe(), or receiving "back pressure" will cause the readable._readableState.flowing to be set as false, temporarily halting the flowing of events but not halting the generation of data.

@Trott
Copy link
Member

Trott commented Aug 13, 2017

This issue has been inactive for sufficiently long that it seems like perhaps it should be closed. Feel free to re-open (or leave a comment requesting that it be re-opened) if you disagree. I'm just tidying up and not acting on a super-strong opinion or anything like that.

@Trott Trott closed this as completed Aug 13, 2017
@ronkorving
Copy link
Contributor Author

From your quotes, I think the docs are probably quite a bit better now. I'm happy 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

No branches or pull requests

5 participants