Skip to content

doc: fixed misinformation in Buffer.allocUnsafe method #50686

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.

Sign up for GitHub

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

Merged
aduh95 merged 2 commits into from
Nov 15, 2023
Merged

doc: fixed misinformation in Buffer.allocUnsafe method #50686

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed451c6
doc: fixed misinformation in Buffer.allocUnsafe method
Nov 12, 2023
03f6ba5
Update buffer.md
mertcanaltin Nov 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: fixed misinformation in Buffer.allocUnsafe method
  • Loading branch information
mert.altin
mert.altin committed Nov 12, 2023
commit ed451c608ddacb2f4392db8cf8ca20357ed0e98f
2 changes: 1 addition & 1 deletion doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,7 +809,7 @@ The `Buffer` module pre-allocates an internal `Buffer` instance of
size [`Buffer.poolSize`][] that is used as a pool for the fast allocation of new
`Buffer` instances created using [`Buffer.allocUnsafe()`][], [`Buffer.from(array)`][],
and [`Buffer.concat()`][] only when `size` is less than or equal to
Comment thread
mertcanaltin marked this conversation as resolved.
Outdated
`Buffer.poolSize >> 1` (floor of [`Buffer.poolSize`][] divided by two).
`Buffer.poolSize >>> 1` (floor of [`Buffer.poolSize`][] divided by two).

Use of this pre-allocated internal memory pool is a key difference between
calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
Expand Down