Skip to content

doc: clarify behavior of napi_extended_error_info #40458

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.

Sign up for GitHub

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

Closed
mhdawson wants to merge 3 commits into from
Closed

doc: clarify behavior of napi_extended_error_info #40458

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfbd981
doc: clarify behavior of napi_extended_error_info
mhdawson Oct 14, 2021
eb18927
fixup: further clarify usage of extended info
mhdawson Oct 18, 2021
6f7499c
Update doc/api/n-api.md
mhdawson Oct 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup: further clarify usage of extended info
  • Loading branch information
@mhdawson
mhdawson authored Oct 18, 2021
commit eb189274e4766d62a8eb93f078e83280dc7cf8e1
5 changes: 4 additions & 1 deletion doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -980,7 +980,10 @@ about the last error that occurred.
The content of the `napi_extended_error_info` returned is only valid up until
a Node-API function is called on the same `env`. This includes a call to
`napi_is_exception_pending` so it may often be necessary to make a copy
of the information so that it can be used later.
of the information so that it can be used later. Note that the pointer returned
Comment thread
mhdawson marked this conversation as resolved.
Outdated
in error_message points to a statically defined string so it is safe to use
that pointer if you have copied it out of the error_message field (which will
be overwritten) before another Node-API function was called.

Do not rely on the content or format of any of the extended information as it
is not subject to SemVer and may change at any time. It is intended only for
Expand Down