Skip to content

Commit df5ae1a

Browse files
tniessenMylesBorins
authored andcommitted
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 <[email protected]> Reviewed-By: Gabriel Schulhof <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent cbe29ce commit df5ae1a

File tree

1 file changed

+0
-4
lines changed

1 file changed

+0
-4
lines changed

doc/api/n-api.md

-4
Original file line numberDiff line numberDiff line change
@@ -1057,8 +1057,6 @@ napi_status napi_get_and_clear_last_exception(napi_env env,
10571057

10581058
Returns `napi_ok` if the API succeeded.
10591059

1060-
This API returns true if an exception is pending.
1061-
10621060
This API can be called even if there is a pending JavaScript exception.
10631061

10641062
#### napi_is_exception_pending
@@ -1076,8 +1074,6 @@ napi_status napi_is_exception_pending(napi_env env, bool* result);
10761074

10771075
Returns `napi_ok` if the API succeeded.
10781076

1079-
This API returns true if an exception is pending.
1080-
10811077
This API can be called even if there is a pending JavaScript exception.
10821078

10831079
#### napi_fatal_exception

0 commit comments

Comments
 (0)