-
Notifications
You must be signed in to change notification settings - Fork 29.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Buffer.toString(): add note about invalid data #30706
Closed
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
Issues and PRs related to the buffer subsystem.
doc
Issues and PRs related to the documentations.
labels
Nov 28, 2019
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 <[email protected]>
lundibundi
added
the
author ready
PRs that have at least one approval, no pending requests for changes, and a CI started.
label
Nov 28, 2019
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 <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: David Carlier <[email protected]>
Landed in c0905b7 🎉 |
targos
pushed a commit
that referenced
this pull request
Dec 9, 2019
PR-URL: #30706 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: David Carlier <[email protected]>
Merged
targos
pushed a commit
that referenced
this pull request
Jan 13, 2020
PR-URL: #30706 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: David Carlier <[email protected]>
BethGriggs
pushed a commit
that referenced
this pull request
Feb 6, 2020
PR-URL: #30706 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: David Carlier <[email protected]>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
author ready
PRs that have at least one approval, no pending requests for changes, and a CI started.
buffer
Issues and PRs related to the buffer subsystem.
doc
Issues and PRs related to the documentations.
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