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

Backport-PR-URL: #19447
PR-URL: #13939
Fixes: nodejs/abi-stable-node#251
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Hitesh Kanwathirtha <digitalinfinity@gmail.com>
  • Loading branch information
mhdawson authored and MylesBorins committed Apr 16, 2018
1 parent c3eb187 commit 36185b3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/api/n-api.md
Original file line number Diff line number Diff line change
@@ -269,7 +269,10 @@ Returns `napi_ok` if the API succeeded.
This API retrieves a `napi_extended_error_info` structure with information
about the last error that occured.
**Note:** Do not rely on the content or format of any of the extended
*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.

0 comments on commit 36185b3

Please sign in to comment.