doc: document Buffer encoding-specific Slice and Write methods - #65209
Open
zeexzeex wants to merge 1 commit into
Open
doc: document Buffer encoding-specific Slice and Write methods#65209zeexzeex wants to merge 1 commit into
zeexzeex wants to merge 1 commit into
Conversation
Document the long-standing *Slice() and *Write() helpers on Buffer.prototype in buffer.md, noting equivalence to toString()/write() and that general callers should prefer those APIs. Fixes: nodejs#46467 Signed-off-by: Avocado <ujubongbong@gmail.com>
nodejs-github-bot
added
buffer
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Document the long-standing encoding-specific
Buffer.prototype.*Slice()and*Write()methods indoc/api/buffer.md.These APIs have been public but undocumented. Maintainer discussion on #46467 favored documenting them (rather than leaving them undocumented), with a recommendation that callers prefer [
buf.toString()][] / [buf.write()][] in the common case.This revisits the approach from closed #48041, with corrected examples/signatures and clearer notes for binary-to-text
*Writemethods (input is encoding text to decode, matchingbuf.write(..., encoding)).Fixes: #46467
Test plan