n-api: update documentation #19078
Closed
n-api: update documentation #19078
Conversation
This file contains 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
nodejs-github-bot
added
doc
gabrielschulhof
force-pushed
the
document-exception-state-apis
branch
from
9ccb573
to
2a071a9
Compare
|
I wonder if we want to lock ourselves into documenting all of these. They may be ok now but I'm not sure how easy it would be to ensure that remains the case. Instead it might be better to just document the ones we think people "should" be able to use while an exception is pending. |
|
@mhdawson I've broken down the functions into groups that I think might be relevant, and placed them in order from least likely to most likely to require Of course, I cannot predict how the language will evolve, and where JS execution hooks will be added - such as with Which do you think we should document? |
|
I think these are needed to handle exceptions: napi_get_last_error_info These are probably useful for cleanup: napi_delete_async_work I'm thinking maybe we just leave it at those. What do you think? |
|
@mhdawson Maybe we should add |
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257
gabrielschulhof
force-pushed
the
document-exception-state-apis
branch
from
2a071a9
to
5480afe
Compare
|
@mhdawson I have reduced the list to the one you proposed + |
|
I don't believe the failures are related. |
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Mar 7, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 PR-URL: nodejs#19078 Reviewed-By: Michael Dawson <[email protected]>
|
Landed in 48b5c11. |
targos
pushed a commit
that referenced
this pull request
Mar 17, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 PR-URL: #19078 Reviewed-By: Michael Dawson <[email protected]>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Mar 20, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 PR-URL: #19078 Reviewed-By: Michael Dawson <[email protected]>
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Apr 12, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 PR-URL: nodejs#19078 Reviewed-By: Michael Dawson <[email protected]>
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Apr 16, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 PR-URL: nodejs#19078 Reviewed-By: Michael Dawson <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 16, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 Backport-PR-URL: #19447 PR-URL: #19078 Reviewed-By: Michael Dawson <[email protected]>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
May 1, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 Backport-PR-URL: #19265 PR-URL: #19078 Reviewed-By: Michael Dawson <[email protected]>
Merged
MayaLekova
pushed a commit
to MayaLekova/node
that referenced
this pull request
May 8, 2018
Document which APIs work while an exception is pending. This is the list of all APIs which do not start with `NAPI_PREAMBLE(env)`. Fixes: nodejs/abi-stable-node#257 PR-URL: nodejs#19078 Reviewed-By: Michael Dawson <[email protected]>
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.
Document which APIs work while an exception is pending.
Fixes: nodejs/abi-stable-node#257
Checklist
Affected core subsystem(s)
n-api