Skip to content

Commit 0c87776

Browse files
puzpuzpuzMylesBorins
authored andcommitted
doc: document Buffer.concat may use internal pool
PR-URL: #35541 Refs: #32703 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Harshitha K P <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Robert Nagy <[email protected]>
1 parent 16c17dd commit 0c87776

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/api/buffer.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -386,9 +386,9 @@ A `TypeError` will be thrown if `size` is not a number.
386386
The `Buffer` module pre-allocates an internal `Buffer` instance of
387387
size [`Buffer.poolSize`][] that is used as a pool for the fast allocation of new
388388
`Buffer` instances created using [`Buffer.allocUnsafe()`][],
389-
[`Buffer.from(array)`][], and the deprecated `new Buffer(size)` constructor only
390-
when `size` is less than or equal to `Buffer.poolSize >> 1` (floor of
391-
[`Buffer.poolSize`][] divided by two).
389+
[`Buffer.from(array)`][], [`Buffer.concat()`][], and the deprecated
390+
`new Buffer(size)` constructor only when `size` is less than or equal
391+
to `Buffer.poolSize >> 1` (floor of [`Buffer.poolSize`][] divided by two).
392392

393393
Use of this pre-allocated internal memory pool is a key difference between
394394
calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
@@ -560,6 +560,9 @@ console.log(bufA.length);
560560
// Prints: 42
561561
```
562562

563+
`Buffer.concat()` may also use the internal `Buffer` pool like
564+
[`Buffer.allocUnsafe()`][] does.
565+
563566
### Static method: `Buffer.from(array)`
564567
<!-- YAML
565568
added: v5.10.0
@@ -3276,6 +3279,7 @@ introducing security vulnerabilities into an application.
32763279
[`Buffer.alloc()`]: #buffer_static_method_buffer_alloc_size_fill_encoding
32773280
[`Buffer.allocUnsafe()`]: #buffer_static_method_buffer_allocunsafe_size
32783281
[`Buffer.allocUnsafeSlow()`]: #buffer_static_method_buffer_allocunsafeslow_size
3282+
[`Buffer.concat()`]: #buffer_static_method_buffer_concat_list_totallength
32793283
[`Buffer.from(array)`]: #buffer_static_method_buffer_from_array
32803284
[`Buffer.from(arrayBuf)`]: #buffer_static_method_buffer_from_arraybuffer_byteoffset_length
32813285
[`Buffer.from(buffer)`]: #buffer_static_method_buffer_from_buffer

0 commit comments

Comments
 (0)