From 36185b343b87751554d780277e6ca5a083a00525 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 26 Jun 2017 18:41:25 -0400 Subject: [PATCH] doc: doc lifetime of n-api last error info Document the lifetime of the structure returned by napi_get_last_error_info Backport-PR-URL: https://github.com/nodejs/node/pull/19447 PR-URL: https://github.com/nodejs/node/pull/13939 Fixes: https://github.com/nodejs/abi-stable-node/issues/251 Reviewed-By: James M Snell Reviewed-By: Colin Ihrig Reviewed-By: Vse Mozhet Byt Reviewed-By: Hitesh Kanwathirtha --- doc/api/n-api.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index f8154d2cb490ec..b1cf4d2306c435 100644 --- 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.