Commit 5a8a7a4
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: #30893
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>1 parent 88085f0 commit 5a8a7a4
1 file changed
Lines changed: 0 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1057,8 +1057,6 @@ napi_status napi_get_and_clear_last_exception(napi_env env, | |||
| 1057 | 1057 | ||
| 1058 | 1058 | Returns `napi_ok` if the API succeeded. | |
| 1059 | 1059 | ||
| 1060 | - This API returns true if an exception is pending. | ||
| 1061 | - | ||
| 1062 | 1060 | This API can be called even if there is a pending JavaScript exception. | |
| 1063 | 1061 | ||
| 1064 | 1062 | #### napi_is_exception_pending | |
@@ -1076,8 +1074,6 @@ napi_status napi_is_exception_pending(napi_env env, bool* result); | |||
| 1076 | 1074 | ||
| 1077 | 1075 | Returns `napi_ok` if the API succeeded. | |
| 1078 | 1076 | ||
| 1079 | - This API returns true if an exception is pending. | ||
| 1080 | - | ||
| 1081 | 1077 | This API can be called even if there is a pending JavaScript exception. | |
| 1082 | 1078 | ||
| 1083 | 1079 | #### napi_fatal_exception | |
0 commit comments