doc: fixed misinformation in Buffer.allocUnsafe method#50686
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
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
nodejs-github-bot added buffer 
jasnell approved these changes Nov 12, 2023
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Leonardo Peixoto <[email protected]>
marco-ippolito approved these changes Nov 13, 2023
marco-ippolito added the author ready 
Contributor
aduh95 commented Nov 15, 2023
Landed in 2d1bc3d |
targos pushed a commit that referenced this pull request Nov 23, 2023
PR-URL: #50686 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
martenrichter pushed a commit to martenrichter/node that referenced this pull request Nov 26, 2023
PR-URL: nodejs#50686 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
Merged
UlisesGascon pushed a commit that referenced this pull request Dec 11, 2023
PR-URL: #50686 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
Merged
UlisesGascon pushed a commit that referenced this pull request Dec 19, 2023
PR-URL: #50686 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
6 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.
issue: #50635
Changes Made:
Corrected the documentation regarding Buffer.allocUnsafe method by adding missing information. The discrepancy was identified in the logic for pre-allocating an internal Buffer. The documentation stated:
... only when size is less than or equal to Buffer.poolSize >> 1 (floor of Buffer.poolSize divided by two).
However, the actual code implementation uses:
I have updated the documentation to accurately reflect the code logic.
Affected URL(s):
https://nodejs.org/dist/latest-v20.x/docs/api/buffer.html#static-method-bufferallocunsafesize