Mention certain ArrayBuffers have controlled detachment #40457
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Josh-Cena
requested review from
chrisdavidmills and
sideshowbarker
and removed request for
a team
github-actions
bot
added
Content:WebAPI
|
Preview URLs
(comment last updated: 2025-07-21 13:20:57) |
chrisdavidmills
requested changes
Jul 21, 2025
There was a problem hiding this comment.
Thanks @Josh-Cena; makes sense, but I've got a question, and a suggestion for clarity.
| ### Exceptions | ||
|
|
||
| - `TypeError` {{domxref("DOMException")}} | ||
| - : Thrown if an attempt is made to detach the {{jsxref("ArrayBuffer")}} in any way other than via {{domxref("GPUBuffer.unmap()")}}. |
There was a problem hiding this comment.
Ah, so you've removed this from here because this isn't an exception of getMappedRange() itself?
| @@ -33,7 +33,7 @@ A new {{jsxref("ArrayBuffer")}} object. Its contents are initialized to the cont | |||
| - {{jsxref("RangeError")}} | |||
| - : Thrown if this `ArrayBuffer` is resizable and `newByteLength` is greater than the {{jsxref("ArrayBuffer/maxByteLength", "maxByteLength")}} of this `ArrayBuffer`. | |||
| - {{jsxref("TypeError")}} | |||
| - : Thrown if this `ArrayBuffer` is already detached. | |||
| - : Thrown if this `ArrayBuffer` is already detached, or if it can only be detached by designated operations. Currently, only certain web APIs are capable of creating such tracked `ArrayBuffer` objects, such as {{domxref("GPUBuffer.getMappedRange()")}} and [`WebAssembly.Memory.buffer`](/en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory/buffer). | |||
There was a problem hiding this comment.
Sounds a bit confusing, and unclear as to how this relates to the method page it appears on. Maybe something like:
Suggested change
| - : Thrown if this `ArrayBuffer` is already detached, or if it can only be detached by designated operations. Currently, only certain web APIs are capable of creating such tracked `ArrayBuffer` objects, such as {{domxref("GPUBuffer.getMappedRange()")}} and [`WebAssembly.Memory.buffer`](/en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory/buffer). | |
| - : Thrown if this `ArrayBuffer` is already detached, or if it can't be detached using `transfer()` and can only be detached by designated operations. Currently, only certain methods are capable of detaching tracked `ArrayBuffer` objects, such as those produced by {{domxref("GPUBuffer.getMappedRange()")}} and [`WebAssembly.Memory.buffer`](/en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory/buffer). |
There was a problem hiding this comment.
Suggested change
| - : Thrown if this `ArrayBuffer` is already detached, or if it can only be detached by designated operations. Currently, only certain web APIs are capable of creating such tracked `ArrayBuffer` objects, such as {{domxref("GPUBuffer.getMappedRange()")}} and [`WebAssembly.Memory.buffer`](/en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory/buffer). | |
| - : Thrown if this `ArrayBuffer` is already detached, or if it can only be detached by designated operations. Currently, only certain web APIs are capable of creating such `ArrayBuffer` objects with designated detaching methods, such as {{domxref("GPUBuffer.getMappedRange()")}} and [`WebAssembly.Memory.buffer`](/en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory/buffer). |
The idea is that you can't create such buffers in userland, and if you have a random array buffer in hand, very likely you don't have to worry about it.
files/en-us/web/javascript/reference/global_objects/arraybuffer/transfertofixedlength/index.md
Outdated
Show resolved
Hide resolved
…r/transfer/index.md
…r/transfertofixedlength/index.md
chrisdavidmills
approved these changes
Jul 21, 2025
There was a problem hiding this comment.
OK, I get it now; thanks @Josh-Cena! I think this works, so approving. I've included a couple of minor language nitpicks for you to consider before merging.
files/en-us/web/javascript/reference/global_objects/arraybuffer/transfer/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/javascript/reference/global_objects/arraybuffer/transfertofixedlength/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Chris Mills <chrisdavidmills@gmail.com>
|
Thanks for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #39021.
The main change is made to the JS docs, but I'm updating
GPUBuffer.getMappedRangeas well, because this is not an exception of this method itself.