n-api: rename 'promise' parameter to 'value'

tniessen · codebytere · commit 16c690373a70 · 2020-03-30T10:59:23.000-07:00
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 <legendecas@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
@@ -4903,12 +4903,12 @@ napiVersion: 1
 
 ```C
 napi_status napi_is_promise(napi_env env,
-                            napi_value promise,
+                            napi_value value,
                             bool* is_promise);
 ```
 
 * `[in] env`: The environment that the API is invoked under.
-* `[in] promise`: The promise to examine
+* `[in] value`: The value to examine
 * `[out] is_promise`: Flag indicating whether `promise` is a native promise
   object (that is, a promise object created by the underlying engine).
 
diff --git a/src/js_native_api.h b/src/js_native_api.h
@@ -440,7 +440,7 @@ NAPI_EXTERN napi_status napi_reject_deferred(napi_env env,
                                              napi_deferred deferred,
                                              napi_value rejection);
 NAPI_EXTERN napi_status napi_is_promise(napi_env env,
-                                        napi_value promise,
+                                        napi_value value,
                                         bool* is_promise);
 
 // Running a script
diff --git a/src/js_native_api_v8.cc b/src/js_native_api_v8.cc
@@ -2911,13 +2911,13 @@ napi_status napi_reject_deferred(napi_env env,
 }
 
 napi_status napi_is_promise(napi_env env,
-                            napi_value promise,
+                            napi_value value,
                             bool* is_promise) {
   CHECK_ENV(env);
-  CHECK_ARG(env, promise);
+  CHECK_ARG(env, value);
   CHECK_ARG(env, is_promise);
 
-  *is_promise = v8impl::V8LocalValueFromJsValue(promise)->IsPromise();
+  *is_promise = v8impl::V8LocalValueFromJsValue(value)->IsPromise();
 
   return napi_clear_last_error(env);
 }

Original file line number	Diff line number	Diff line change
`@@ -2911,13 +2911,13 @@ napi_status napi_reject_deferred(napi_env env,`
`2911`	`2911`	`}`
`2912`	`2912`
`2913`	`2913`	`napi_status napi_is_promise(napi_env env,`
`2914`		`- napi_value promise,`
	`2914`	`+ napi_value value,`
`2915`	`2915`	`bool* is_promise) {`
`2916`	`2916`	`CHECK_ENV(env);`
`2917`		`- CHECK_ARG(env, promise);`
	`2917`	`+ CHECK_ARG(env, value);`
`2918`	`2918`	`CHECK_ARG(env, is_promise);`
`2919`	`2919`
`2920`		`- *is_promise = v8impl::V8LocalValueFromJsValue(promise)->IsPromise();`
	`2920`	`+ *is_promise = v8impl::V8LocalValueFromJsValue(value)->IsPromise();`
`2921`	`2921`
`2922`	`2922`	`return napi_clear_last_error(env);`
`2923`	`2923`	`}`