-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
doc: add missing worker error #21947
Conversation
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER was missing from the docs - add it there based on the wording Anna used in the her PR. PR-URL: Reviewed-By:
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.
Thanks for doing the PR here!
doc/api/errors.md
Outdated
|
||
A SharedArrayBuffer object was transfered but we do not see a lifetime partner | ||
object and it was not us who externalized it - we are not sure how to serialize | ||
it because it's unclear how the memory is actually owned. |
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.
This description makes sense as a code comment, but it might not be ideal for the docs. How about this?
A
SharedArrayBuffer
object was encountered during serialization whose memory is not managed by the JavaScript engine or by Node. Such anSharedArrayBuffer
can not be serialized.This can only happen when native addons create
SharedArrayBuffer
s in “externalized” mode, or put existingSharedArrayBuffer
into externalized mode.
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.
Sure, sounds good.
@benjamingr Thanks! In fact, this was noticed by a testcase from #21470 😉. |
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.
Thank you!
doc/api/errors.md
Outdated
<a id="ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER"></a> | ||
### ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER | ||
|
||
A `SharedArrayBuffer` whose memory is not managed by the JavaScript engine or by Node.js was |
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.
Line length here and below)
doc/api/errors.md
Outdated
### ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER | ||
|
||
A `SharedArrayBuffer` whose memory is not managed by the JavaScript engine or by Node.js was | ||
encountered during serialization. Such a `SharedArrayBuffer` can not be serialized. |
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 not -> cannot?
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
Landed in f42aa32 |
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER was missing from the docs - add it there based on the wording Anna used in the her PR. PR-URL: #21947 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Minwoo Jung <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER was missing from the docs - add it there based on the wording Anna used in the her PR. PR-URL: #21947 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Minwoo Jung <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
@ChALkeR noticed that
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER
was missing from the docs. This PR adds it there based on the wording @addaleax used in the her PR.Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes