diff options
| author | Tobias Nießen <tniessen@tnie.de> | 2019-12-11 07:45:19 +0300 |
|---|---|---|
| committer | Myles Borins <mylesborins@google.com> | 2019-12-18 02:17:22 +0300 |
| commit | df5ae1a8ef449082d9a950732b452560c2d6d779 (patch) | |
| tree | 94e5d38cc9b3fba7a8d2f9e3fb1c08cc1355a523 /doc/api | |
| parent | cbe29ce4cf10a62d960dbd01208c99a470818eae (diff) | |
doc: fix description of N-API exception handlers
The return value is not a boolean and even if interpreted as one,
it does not indicate whether an exception is pending.
For napi_is_exception_pending, the description of the result parameter
already explains how to check whether an exception is pending.
PR-URL: https://github.com/nodejs/node/pull/30893
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/n-api.md | 4 |
1 files changed, 0 insertions, 4 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index bcb8504e948..1eecb7f1129 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -1057,8 +1057,6 @@ napi_status napi_get_and_clear_last_exception(napi_env env, Returns `napi_ok` if the API succeeded. -This API returns true if an exception is pending. - This API can be called even if there is a pending JavaScript exception. #### napi_is_exception_pending @@ -1076,8 +1074,6 @@ napi_status napi_is_exception_pending(napi_env env, bool* result); Returns `napi_ok` if the API succeeded. -This API returns true if an exception is pending. - This API can be called even if there is a pending JavaScript exception. #### napi_fatal_exception |