Skip to content

Commit 16c6903

Browse files
tniessencodebytere
authored andcommitted
n-api: rename 'promise' parameter to 'value'
This change makes it clear that the value doesn't need to be a Promise, and makes the signature consistent with other napi_is_* functions. PR-URL: #31544 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: David Carlier <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent f5663d9 commit 16c6903

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

Diff for: doc/api/n-api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4903,12 +4903,12 @@ napiVersion: 1
49034903

49044904
```C
49054905
napi_status napi_is_promise(napi_env env,
4906-
napi_value promise,
4906+
napi_value value,
49074907
bool* is_promise);
49084908
```
49094909

49104910
* `[in] env`: The environment that the API is invoked under.
4911-
* `[in] promise`: The promise to examine
4911+
* `[in] value`: The value to examine
49124912
* `[out] is_promise`: Flag indicating whether `promise` is a native promise
49134913
object (that is, a promise object created by the underlying engine).
49144914

Diff for: src/js_native_api.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ NAPI_EXTERN napi_status napi_reject_deferred(napi_env env,
440440
napi_deferred deferred,
441441
napi_value rejection);
442442
NAPI_EXTERN napi_status napi_is_promise(napi_env env,
443-
napi_value promise,
443+
napi_value value,
444444
bool* is_promise);
445445

446446
// Running a script

Diff for: src/js_native_api_v8.cc

+3-3
Original file line numberDiff line numberDiff line change
@@ -2911,13 +2911,13 @@ napi_status napi_reject_deferred(napi_env env,
29112911
}
29122912

29132913
napi_status napi_is_promise(napi_env env,
2914-
napi_value promise,
2914+
napi_value value,
29152915
bool* is_promise) {
29162916
CHECK_ENV(env);
2917-
CHECK_ARG(env, promise);
2917+
CHECK_ARG(env, value);
29182918
CHECK_ARG(env, is_promise);
29192919

2920-
*is_promise = v8impl::V8LocalValueFromJsValue(promise)->IsPromise();
2920+
*is_promise = v8impl::V8LocalValueFromJsValue(value)->IsPromise();
29212921

29222922
return napi_clear_last_error(env);
29232923
}

0 commit comments

Comments
 (0)