Commit 73939ec
doc: clarify memory sharing behavior of buffer ctor
* Clarify that memory is always shared and never copied.
* Fix wording that sounded like ArrayBuffer has a buffer property.
PR-URL: #10778
Ref: #10770
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent f8b081b commit 73939ec
1 file changed
Lines changed: 16 additions & 14 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -348,15 +348,16 @@ deprecated: v6.0.0 | |||
| 348 | 348 | > [`Buffer.from(arrayBuffer[, byteOffset [, length]])`][`Buffer.from(arrayBuffer)`] | |
| 349 | 349 | > instead. | |
| 350 | 350 | ||
| 351 | - * `arrayBuffer` {ArrayBuffer} The `.buffer` property of a [`TypedArray`] or | ||
| 352 | - [`ArrayBuffer`] | ||
| 353 | - * `byteOffset` {Integer} Where to start copying from `arrayBuffer`. **Default:** `0` | ||
| 354 | - * `length` {Integer} How many bytes to copy from `arrayBuffer`. | ||
| 351 | + * `arrayBuffer` {ArrayBuffer} An [`ArrayBuffer`] or the `.buffer` property of a | ||
| 352 | + [`TypedArray`]. | ||
| 353 | + * `byteOffset` {Integer} Index of first byte to expose. **Default:** `0` | ||
| 354 | + * `length` {Integer} Number of bytes to expose. | ||
| 355 | 355 | **Default:** `arrayBuffer.length - byteOffset` | |
| 356 | 356 | ||
| 357 | - When passed a reference to the `.buffer` property of a [`TypedArray`] instance, | ||
| 358 | - the newly created `Buffer` will share the same allocated memory as the | ||
| 359 | - [`TypedArray`]. | ||
| 357 | + This creates a view of the [`ArrayBuffer`] without copying the underlying | ||
| 358 | + memory. For example, when passed a reference to the `.buffer` property of a | ||
| 359 | + [`TypedArray`] instance, the newly created `Buffer` will share the same | ||
| 360 | + allocated memory as the [`TypedArray`]. | ||
| 360 | 361 | ||
| 361 | 362 | The optional `byteOffset` and `length` arguments specify a memory range within | |
| 362 | 363 | the `arrayBuffer` that will be shared by the `Buffer`. | |
@@ -719,15 +720,16 @@ A `TypeError` will be thrown if `array` is not an `Array`. | |||
| 719 | 720 | added: v5.10.0 | |
| 720 | 721 | --> | |
| 721 | 722 | ||
| 722 | - * `arrayBuffer` {ArrayBuffer} The `.buffer` property of a [`TypedArray`] or | ||
| 723 | - [`ArrayBuffer`] | ||
| 724 | - * `byteOffset` {Integer} Where to start copying from `arrayBuffer`. **Default:** `0` | ||
| 725 | - * `length` {Integer} How many bytes to copy from `arrayBuffer`. | ||
| 723 | + * `arrayBuffer` {ArrayBuffer} An [`ArrayBuffer`] or the `.buffer` property of a | ||
| 724 | + [`TypedArray`]. | ||
| 725 | + * `byteOffset` {Integer} Index of first byte to expose. **Default:** `0` | ||
| 726 | + * `length` {Integer} Number of bytes to expose. | ||
| 726 | 727 | **Default:** `arrayBuffer.length - byteOffset` | |
| 727 | 728 | ||
| 728 | - When passed a reference to the `.buffer` property of a [`TypedArray`] instance, | ||
| 729 | - the newly created `Buffer` will share the same allocated memory as the | ||
| 730 | - [`TypedArray`]. | ||
| 729 | + This creates a view of the [`ArrayBuffer`] without copying the underlying | ||
| 730 | + memory. For example, when passed a reference to the `.buffer` property of a | ||
| 731 | + [`TypedArray`] instance, the newly created `Buffer` will share the same | ||
| 732 | + allocated memory as the [`TypedArray`]. | ||
| 731 | 733 | ||
| 732 | 734 | Example: | |
| 733 | 735 | ||
0 commit comments