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
Next Next commit
doc: clarify behavior of napi_extended_error_info 
Fix up example and make it more explicit on how
you need to use napi_extended_error_info in order to
help people avoid what might be a common mistake that
we made in node-addon-api.

Refs: nodejs/node-addon-api#1089

Signed-off-by: Michael Dawson <mdawson@devrus.com>
  • Loading branch information
@mhdawson
mhdawson committed Oct 14, 2021
commit dfbd981080abe68f011f6eec3c5e02387a709f11
9 changes: 6 additions & 3 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,12 +403,13 @@ napi_value create_addon(napi_env env);
if (status != napi_ok) { \
const napi_extended_error_info* error_info = NULL; \
napi_get_last_error_info((env), &error_info); \
const char* err_message = error_info->error_message; \
Comment thread
RaisinTen marked this conversation as resolved.
bool is_pending; \
napi_is_exception_pending((env), &is_pending); \
if (!is_pending) { \
const char* message = (error_info->error_message == NULL) \
const char* message = (err_message == NULL) \
? "empty error message" \
: error_info->error_message; \
: err_message; \
napi_throw_error((env), NULL, message); \
return NULL; \
} \
Expand Down Expand Up @@ -977,7 +978,9 @@ This API retrieves a `napi_extended_error_info` structure with information
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`.
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.

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