-
Notifications
You must be signed in to change notification settings - Fork 31.2k
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.
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
Add SharedArrayBuffer to Buffer documentation #15489
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -66,8 +66,8 @@ differently based on what arguments are provided: | |
memory. | ||
* Passing a string, array, or `Buffer` as the first argument copies the | ||
passed object's data into the `Buffer`. | ||
* Passing an [`ArrayBuffer`] returns a `Buffer` that shares allocated memory with | ||
the given [`ArrayBuffer`]. | ||
* Passing an [`ArrayBuffer`] or a [`SharedArrayBuffer`] returns a `Buffer` that | ||
shares allocated memory with the given array buffer. | ||
|
||
Because the behavior of `new Buffer()` changes significantly based on the type | ||
of value passed as the first argument, applications that do not properly | ||
|
@@ -361,16 +361,16 @@ changes: | |
> [`Buffer.from(arrayBuffer[, byteOffset [, length]])`][`Buffer.from(arrayBuffer)`] | ||
> instead. | ||
|
||
* `arrayBuffer` {ArrayBuffer} An [`ArrayBuffer`] or the `.buffer` property of a | ||
[`TypedArray`]. | ||
* `arrayBuffer` {ArrayBuffer} An [`ArrayBuffer`], [`SharedArrayBuffer`] or the | ||
`.buffer` property of a [`TypedArray`]. | ||
* `byteOffset` {integer} Index of first byte to expose. **Default:** `0` | ||
* `length` {integer} Number of bytes to expose. | ||
**Default:** `arrayBuffer.length - byteOffset` | ||
|
||
This creates a view of the [`ArrayBuffer`] without copying the underlying | ||
memory. For example, when passed a reference to the `.buffer` property of a | ||
[`TypedArray`] instance, the newly created `Buffer` will share the same | ||
allocated memory as the [`TypedArray`]. | ||
This creates a view of the [`ArrayBuffer`] or [`SharedArrayBuffer`] without | ||
copying the underlying memory. For example, when passed a reference to the | ||
`.buffer` property of a [`TypedArray`] instance, the newly created `Buffer` will | ||
share the same allocated memory as the [`TypedArray`]. | ||
|
||
The optional `byteOffset` and `length` arguments specify a memory range within | ||
the `arrayBuffer` that will be shared by the `Buffer`. | ||
|
@@ -703,8 +703,8 @@ console.log(`${str}: ${str.length} characters, ` + | |
`${Buffer.byteLength(str, 'utf8')} bytes`); | ||
``` | ||
|
||
When `string` is a `Buffer`/[`DataView`]/[`TypedArray`]/[`ArrayBuffer`], the | ||
actual byte length is returned. | ||
When `string` is a `Buffer`/[`DataView`]/[`TypedArray`]/[`ArrayBuffer`]/ | ||
[`SharedArrayBuffer`], the actual byte length is returned. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto. |
||
|
||
### Class Method: Buffer.compare(buf1, buf2) | ||
<!-- YAML | ||
|
@@ -807,8 +807,8 @@ A `TypeError` will be thrown if `array` is not an `Array`. | |
added: v5.10.0 | ||
--> | ||
|
||
* `arrayBuffer` {ArrayBuffer} An [`ArrayBuffer`] or the `.buffer` property of a | ||
[`TypedArray`]. | ||
* `arrayBuffer` {ArrayBuffer} An [`ArrayBuffer`], [`SharedArrayBuffer`], or the | ||
`.buffer` property of a [`TypedArray`]. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto. |
||
* `byteOffset` {integer} Index of first byte to expose. **Default:** `0` | ||
* `length` {integer} Number of bytes to expose. | ||
**Default:** `arrayBuffer.length - byteOffset` | ||
|
@@ -852,7 +852,8 @@ const buf = Buffer.from(ab, 0, 2); | |
console.log(buf.length); | ||
``` | ||
|
||
A `TypeError` will be thrown if `arrayBuffer` is not an [`ArrayBuffer`]. | ||
A `TypeError` will be thrown if `arrayBuffer` is not an [`ArrayBuffer`] or a | ||
[`SharedArrayBuffer`]. | ||
|
||
### Class Method: Buffer.from(buffer) | ||
<!-- YAML | ||
|
@@ -2702,6 +2703,7 @@ This value may depend on the JS engine that is being used. | |
|
||
[`ArrayBuffer#slice()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/slice | ||
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ||
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you please move this line to keep the alphabetical order? |
||
[`Buffer.alloc()`]: #buffer_class_method_buffer_alloc_size_fill_encoding | ||
[`Buffer.allocUnsafe()`]: #buffer_class_method_buffer_allocunsafe_size | ||
[`Buffer.allocUnsafeSlow()`]: #buffer_class_method_buffer_allocunsafeslow_size | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you change
{ArrayBuffer}
to{ArrayBuffer|SharedArrayBuffer}
as well?