doc: update description of External
#31255
Closed
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
The previous description did not mention what an `External` is and instead only provided some hints around what it is not. Update the description to be more accurate.
doc/api/util.md
Outdated
|
|
||
| A native `External` value is a special type of object that contains a | ||
| C++ `void*` pointer for access from native code, and has no other properties. | ||
| Such objects are created either by Node.js internals or native addons. |
Member
There was a problem hiding this comment.
@addaleax - while this is more specific definition of external types, the existing text is more consumable by end users IMO. For easy consumption while being accurate, shall I suggest to retain data is not stored within the JavaScript managed heap and does not conform to standard JavaScript types.. phrase?
Member
Author
There was a problem hiding this comment.
@gireeshpunathil Sorry, but I have to disagree. The previous text was far from ideal, imo:
Externals are not concerned with where data is stored, or whether data is associated with theExternalat all. They could even be used to store a single machine-word-sized value (which would mean that theExternal’s data is actually fully stored on the JS heap).- Saying that an object “does not conform to standard JavaScript types” without describing in what way it doesn’t conform is just not helpful, and worse,
Externalobjects do conform to standard JS behaviour – in JS, they’re indistinguishable fromObject.freeze(Object.create(null)).
I’m happy to take updates here, but I’d like to keep things helpful and accurate.
Member
There was a problem hiding this comment.
Suggested change
| Such objects are created either by Node.js internals or native addons. | |
| Such objects are created either by Node.js internals or native addons. | |
| In JS, they’re indistinguishable from `Object.freeze(Object.create(null))`. |
Would it be possible to reword the ...contains a C++ `void*` pointer part? A pure JS developers might not be able to follow the part otherwise.
Member
Author
There was a problem hiding this comment.
@BridgeAR I’ve reworded the text a bit along the lines of your suggestions, but I’m not quite sure what you had in mind for the second one?
Member
There was a problem hiding this comment.
I did not think of anything specific. I guess it's fine as it is.
antsmartian
approved these changes
Jan 8, 2020
Contributor
There was a problem hiding this comment.
With the example being added here: #31173
This content change looks good to me.
BridgeAR
approved these changes
Jan 8, 2020
devnexen
approved these changes
Jan 8, 2020
cjihrig
approved these changes
Jan 8, 2020
lpinca
approved these changes
Jan 8, 2020
Trott
reviewed
Jan 9, 2020
jasnell
approved these changes
Jan 10, 2020
Trott
pushed a commit
that referenced
this pull request
Jan 10, 2020
The previous description did not mention what an `External` is and instead only provided some hints around what it is not. Update the description to be more accurate. PR-URL: #31255 Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Member
|
Landed in b4ae0cb |
MylesBorins
pushed a commit
that referenced
this pull request
Jan 16, 2020
The previous description did not mention what an `External` is and instead only provided some hints around what it is not. Update the description to be more accurate. PR-URL: #31255 Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
codebytere
pushed a commit
that referenced
this pull request
Mar 14, 2020
The previous description did not mention what an `External` is and instead only provided some hints around what it is not. Update the description to be more accurate. PR-URL: #31255 Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
codebytere
pushed a commit
that referenced
this pull request
Mar 17, 2020
The previous description did not mention what an `External` is and instead only provided some hints around what it is not. Update the description to be more accurate. PR-URL: #31255 Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
10 participants
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.
The previous description did not mention what an
Externalis and instead only provided some hints around what it is not. Update the description to be more accurate./cc @Trott @BridgeAR @cjihrig @gireeshpunathil who reviewed the previous PR.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes