doc: doc lifetime of n-api last error info

Document the lifetime of the structure returned by napi_get_last_error_info PR-URL: nodejs#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]>
gabrielschulhof · Apr 10, 2018 · 512fc32 · 512fc32
1 parent f680c08
commit 512fc32
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
@@ -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.