doc: make unshift doc compliant with push doc #28953
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
nodejs-github-bot
added
doc
mscdex
reviewed
Aug 3, 2019
readable.unshift() also allows to pass null and end stream readable.push() don't allow null when in object mode
EduardoRFS
changed the title
|
Updated <3 |
mscdex
reviewed
Aug 4, 2019
Co-Authored-By: mscdex <mscdex@users.noreply.github.com>
Trott
reviewed
Aug 6, 2019
doc/api/stream.md
Outdated
| read queue. For streams not operating in object mode, `chunk` must be a | ||
| string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be | ||
| any JavaScript value other than `null`. | ||
| * `encoding` {string} Encoding of string chunks. Must be a valid | ||
| `Buffer` encoding, such as `'utf8'` or `'ascii'`. | ||
|
|
||
| Passing `chunk` as `null` signals the end of the stream (EOF), after which no more data can be written. |
There was a problem hiding this comment.
This will (I hope) cause the linter to fail because it is longer than 80 characters. Word wrap at 80 chars? To run the markdown linter, you can run make lint-md (or, if on Windows, vcbuild lint-md).
Trott
reviewed
Aug 6, 2019
|
/ping @nodejs/streams |
|
I made the changes (line-wrap and more |
jasnell
approved these changes
Aug 7, 2019
Trott
approved these changes
Aug 7, 2019
|
Landed in 84a6384. Thanks for the contribution! 🎉 |
Trott
pushed a commit
to Trott/io.js
that referenced
this pull request
Aug 7, 2019
readable.unshift() also allows to pass null and end stream PR-URL: nodejs#28953 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
targos
pushed a commit
that referenced
this pull request
Aug 19, 2019
readable.unshift() also allows to pass null and end stream PR-URL: #28953 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
This was referenced Aug 20, 2019
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.
As
readable.unshift()share implementation withreadable.push()it makes sense to make the doc similar.Checklist