Skip to content

Commit

Permalink
doc: doc lifetime of n-api last error info
Browse files Browse the repository at this point in the history
Document the lifetime of the structure returned
by napi_get_last_error_info

PR-URL: #13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Hitesh Kanwathirtha <[email protected]>
  • Loading branch information
mhdawson authored and addaleax committed Jul 11, 2017
1 parent 1da2239 commit 5313390
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/n-api.md
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
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

0 comments on commit 5313390

Please sign in to comment.