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: add docs for more stream options #4639

Closed
wants to merge 1 commit into from

Conversation

zoubin
Copy link
Contributor

@zoubin zoubin commented Jan 12, 2016

It seems that _read, _write and _transform can be set by specifying them in the options object passed to stream constructors. But that behaviour has not been documented yet.
If this is a right way users are expected to create streams, I'd like to add some docs.

@mscdex mscdex added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Jan 12, 2016
@jmm
Copy link
Contributor

jmm commented Jan 12, 2016

It's not totally undocumented, but I agree there's room for improvement: https://nodejs.org/api/stream.html#stream_simplified_constructor_api.

@zoubin
Copy link
Contributor Author

zoubin commented Jan 12, 2016

@jmm Ah, I've missed that. Thank you for pointing it out.

@a0viedo
Copy link
Member

a0viedo commented Jan 12, 2016

cc @nodejs/documentation

@benjamingr
Copy link
Member

LGTM. This sounds like a useful addition for new users looking into the API.

@jasnell
Copy link
Member

jasnell commented Jan 12, 2016

LGTM

@jasnell
Copy link
Member

jasnell commented Jan 12, 2016

@trevnorris

@chrisdickinson
Copy link
Contributor

LGTM!

jasnell pushed a commit that referenced this pull request Jan 12, 2016
PR-URL: #4639
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Chris Dickinson <[email protected]>
@jasnell
Copy link
Member

jasnell commented Jan 12, 2016

Landed in eeb6fdc

@jasnell jasnell closed this Jan 12, 2016
@zoubin zoubin deleted the add-docs-for-stream-api branch January 13, 2016 04:38
rvagg pushed a commit that referenced this pull request Jan 14, 2016
PR-URL: #4639
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Chris Dickinson <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jan 28, 2016
PR-URL: #4639
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Chris Dickinson <[email protected]>
MylesBorins pushed a commit that referenced this pull request Feb 11, 2016
PR-URL: #4639
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Chris Dickinson <[email protected]>
MylesBorins pushed a commit to MylesBorins/node that referenced this pull request Feb 11, 2016
PR-URL: nodejs#4639
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Chris Dickinson <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Feb 11, 2016
MylesBorins pushed a commit to MylesBorins/node that referenced this pull request Feb 15, 2016
PR-URL: nodejs#4639
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Chris Dickinson <[email protected]>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
PR-URL: nodejs#4639
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Chris Dickinson <[email protected]>
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

Successfully merging this pull request may close these issues.

8 participants