From df5ae1a8ef449082d9a950732b452560c2d6d779 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Tue, 10 Dec 2019 23:45:19 -0500 Subject: [PATCH] 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 Reviewed-By: Gabriel Schulhof Reviewed-By: Anna Henningsen --- doc/api/n-api.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index bcb8504e948f6a..1eecb7f1129c40 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