Skip to content

doc: doc lifetime of n-api last error info #13939

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 2 commits into from
Closed

doc: doc lifetime of n-api last error info #13939

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90adc69
doc: doc lifetime of n-api last error info
mhdawson Jun 26, 2017
e871aee
squash: address comments
mhdawson Jun 27, 2017
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: doc lifetime of n-api last error info 
Document the lifetime of the structure returned
by napi_get_last_error_info

Fixes: nodejs/abi-stable-node#251
  • Loading branch information
@mhdawson
mhdawson committed Jun 26, 2017
commit 90adc693ba5cbed55a1d51bb655744cb1763281c
3 changes: 3 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,9 @@ Returns `napi_ok` if the API succeeded.
This API retrieves a `napi_extended_error_info` structure with information
about the last error that occurred.

*Note*: The content of the 'napi_extended_error_info` returned is only
Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Jun 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong quote before napi_?

Copy link
Copy Markdown
Member Author

@mhdawson mhdawson Jun 27, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks ! Pushed commit to fix.

valid up until an n-api function is called on the same `env`.

*Note*: 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 logging purposes.
Expand Down