docs: Buffer.toString(): add note about invalid data #30706
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
buffer
|
Future potential addition: we might want to say
|
addaleax
approved these changes
Nov 28, 2019
lundibundi
approved these changes
Nov 28, 2019
Co-Authored-By: Denys Otrishko <9109612+lundibundi@users.noreply.github.com>
lundibundi
added
the
author ready
trivikr
approved these changes
Nov 28, 2019
cjihrig
approved these changes
Nov 29, 2019
devnexen
approved these changes
Nov 29, 2019
addaleax
pushed a commit
that referenced
this pull request
Dec 3, 2019
PR-URL: #30706 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com>
|
Landed in c0905b7 🎉 |
targos
pushed a commit
that referenced
this pull request
Dec 9, 2019
PR-URL: #30706 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com>
Merged
targos
pushed a commit
that referenced
this pull request
Jan 13, 2020
PR-URL: #30706 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com>
BethGriggs
pushed a commit
that referenced
this pull request
Feb 6, 2020
PR-URL: #30706 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com>
Merged
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.
New to the ecosystem. I looked up the docs to see how
Buffer.toString()behaves upon invalid input data (for building solid code it's of course critically important to know whether it throws an error, or if it performs a surrogate escape instead). Is not documented as of today.Once we modify the documentation we can close #23280.
There is an existing patch: #28249 -- but it's probably too controversial as of the amount of information I think.
I tried to stay minimal here, so that we at least don't ignore the topic in the docs.
#6075 is about the same topic, I think nobody questions that we need to have the behavior of
toString()documented w.r.t. invalid byte sequences in the input.Checklist