doc: add docs for more stream options #4639
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mscdex
added
doc
|
It's not totally undocumented, but I agree there's room for improvement: https://nodejs.org/api/stream.html#stream_simplified_constructor_api. |
|
@jmm Ah, I've missed that. Thank you for pointing it out. |
|
cc @nodejs/documentation |
|
LGTM. This sounds like a useful addition for new users looking into the API. |
|
LGTM |
|
LGTM! |
jasnell
pushed a commit
that referenced
this pull request
Jan 12, 2016
PR-URL: #4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
|
Landed in eeb6fdc |
rvagg
pushed a commit
that referenced
this pull request
Jan 14, 2016
PR-URL: #4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
MylesBorins
pushed a commit
that referenced
this pull request
Jan 28, 2016
PR-URL: #4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 11, 2016
PR-URL: #4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
MylesBorins
pushed a commit
to MylesBorins/node
that referenced
this pull request
Feb 11, 2016
PR-URL: nodejs#4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
Merged
MylesBorins
pushed a commit
to MylesBorins/node
that referenced
this pull request
Feb 15, 2016
PR-URL: nodejs#4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
scovetta
pushed a commit
to scovetta/node
that referenced
this pull request
Apr 2, 2016
PR-URL: nodejs#4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It seems that
_read,_writeand_transformcan be set by specifying them in theoptionsobject 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.