diff options
| author | Michael Dawson <michael_dawson@ca.ibm.com> | 2017-06-26 18:41:25 -0400 |
|---|---|---|
| committer | Michael Dawson <michael_dawson@ca.ibm.com> | 2017-06-28 14:31:59 -0400 |
| commit | ef28d85611bcb1b0d91b6525b7c16517bf21020c (patch) | |
| tree | e33438daff9b3a40b7e32681dd616bde5bc06888 /doc | |
| parent | 2fa2a6072199aeb84886878e6b7048021c545e42 (diff) | |
| download | android-node-v8-ef28d85611bcb1b0d91b6525b7c16517bf21020c.tar.gz android-node-v8-ef28d85611bcb1b0d91b6525b7c16517bf21020c.tar.bz2 android-node-v8-ef28d85611bcb1b0d91b6525b7c16517bf21020c.zip | |
doc: doc lifetime of n-api last error info
Document the lifetime of the structure returned
by napi_get_last_error_info
PR-URL: https://github.com/nodejs/node/pull/13939
Fixes: https://github.com/nodejs/abi-stable-node/issues/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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/n-api.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index f6e225488c..da26b88710 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -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. |