doc: make unshift doc compliant with push doc - #28953
Conversation
Sorry, something went wrong.
readable.unshift() also allows to pass null and end stream readable.push() don't allow null when in object mode
|
Updated <3 |
Sorry, something went wrong.
Co-Authored-By: mscdex <mscdex@users.noreply.github.com>
| * `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).
Sorry, something went wrong.
|
/ping @nodejs/streams |
Sorry, something went wrong.
|
I made the changes (line-wrap and more null clarification) and pushed up to the branch. I kept my changes in a separate fixup commit so they can be removed easily. @mscdex LGTY? |
Sorry, something went wrong.
Sorry, something went wrong.
mcollina
left a comment
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
|
Landed in 84a6384. Thanks for the contribution! 🎉 |
Sorry, something went wrong.
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>
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>
As readable.unshift() share implementation with readable.push() it makes sense to make the doc similar.
Checklist