Commit 9861ec9
doc: increase Buffer.concat() documentation
This commit adds documentation for two edge cases in
Buffer.concat(). Those cases are:
- totalLength is specified, but is not an integer.
- The combined buffer length is greater than totalLength.
PR-URL: #11845
Fixes: #11605
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent 54879ab commit 9861ec9
1 file changed
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -747,6 +747,10 @@ in `list`. This however causes an additional loop to be executed in order to | |||
| 747 | 747 | calculate the `totalLength`, so it is faster to provide the length explicitly if | |
| 748 | 748 | it is already known. | |
| 749 | 749 | ||
| 750 | + If `totalLength` is provided, it is coerced to an unsigned integer. If the | ||
| 751 | + combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is | ||
| 752 | + truncated to `totalLength`. | ||
| 753 | + | ||
| 750 | 754 | Example: Create a single `Buffer` from a list of three `Buffer` instances | |
| 751 | 755 | ||
| 752 | 756 | ```js | |
0 commit comments