doc: how to decode buffers extending from Writable #16403
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
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: #15369
nodejs-github-bot
added
doc
|
Hi @dicearr! Thank you for a try to improve the docs. We lint code fragments in docs (you can run Currently, there are some issues with the linter:
You can fix them in a new commit or amend the existing one. |
gireeshpunathil
approved these changes
Oct 24, 2017
|
cc @nodejs/documentation |
benjamingr
approved these changes
Oct 30, 2017
mcollina
approved these changes
Oct 30, 2017
doc/api/stream.md
Outdated
|
|
||
| Decoding buffers is a common task, for instance, when using transformers whose | ||
| input is a string. This is not a trivial process when using multi-byte | ||
| characters encoding. Implement it within [Writable][] implies some performance |
There was a problem hiding this comment.
I would add: "...multi-byte characters encoding, such as UTF-8."
I would remove the sentence "Implement it within Writable implies some performance regressions".
Then:
"The following example shows how to decode multi-byte strings using StringDecoder and Writable."
doc/api/stream.md
Outdated
| this._data += this._decoder.end(); | ||
| callback(); | ||
| } | ||
| } |
There was a problem hiding this comment.
it would be good to add a quick example on how to use this.
mcollina
reviewed
Oct 31, 2017
doc/api/stream.md
Outdated
| w.write(euro[0]); | ||
| w.end(euro[1]); | ||
|
|
||
| console.log(w._data); // currency: € |
There was a problem hiding this comment.
can you please rename _data into data? accessing a prefixed property from outside is encouraging to tinker with the stream private properties, which is something we would like to avoid.
|
CI failures are unrelated, landing. Thanks for your first contribution @dicearr 🎉 ! |
|
Landed as e509db8! |
mcollina
pushed a commit
that referenced
this pull request
Oct 31, 2017
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: #15369 PR-URL: #16403 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
Qard
pushed a commit
to ayojs/ayo
that referenced
this pull request
Nov 2, 2017
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: nodejs/node#15369 PR-URL: nodejs/node#16403 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
Qard
pushed a commit
to ayojs/ayo
that referenced
this pull request
Nov 2, 2017
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: nodejs/node#15369 PR-URL: nodejs/node#16403 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
cjihrig
pushed a commit
to cjihrig/node
that referenced
this pull request
Nov 6, 2017
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: nodejs#15369 PR-URL: nodejs#16403 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
Merged
gibfahn
pushed a commit
that referenced
this pull request
Nov 14, 2017
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: #15369 PR-URL: #16403 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Nov 14, 2017
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: #15369 PR-URL: #16403 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
Merged
Merged
addaleax
pushed a commit
to ayojs/ayo
that referenced
this pull request
Dec 7, 2017
Improved stream documentation with an example of how to decode buffers to strings within a custom Writable. Fixes: nodejs/node#15369 PR-URL: nodejs/node#16403 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
This was referenced May 13, 2024
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.
Improved stream documentation with an example of how to decode buffers
to strings within a custom Writable.
Fixes: #15369
Checklist
Affected core subsystem(s)
doc