diff options
| author | Michael Dawson <michael_dawson@ca.ibm.com> | 2019-11-04 16:38:45 -0500 |
|---|---|---|
| committer | Kamat, Trivikram <16024985+trivikr@users.noreply.github.com> | 2019-11-12 17:11:39 -0800 |
| commit | 1e0679e56d8e340821fc803073df215c1145dc5b (patch) | |
| tree | 2849ac66785fc7b78c57b5c0e1bca30d69d560f8 /doc/api/n-api.md | |
| parent | 3d926898db50699e081a8ce077e212339fde082c (diff) | |
| download | android-node-v8-1e0679e56d8e340821fc803073df215c1145dc5b.tar.gz android-node-v8-1e0679e56d8e340821fc803073df215c1145dc5b.tar.bz2 android-node-v8-1e0679e56d8e340821fc803073df215c1145dc5b.zip | |
doc: fix up N-API doc
* Add missing N-API version info
* Fix N-API version info for napi_extended_error_info
PR-URL: https://github.com/nodejs/node/pull/30254
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Diffstat (limited to 'doc/api/n-api.md')
| -rw-r--r-- | doc/api/n-api.md | 40 |
1 files changed, 22 insertions, 18 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index ff72a4fe66..0e88387e51 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -729,8 +729,8 @@ is provided which returns a `napi_extended_error_info` structure. The format of the `napi_extended_error_info` structure is as follows: <!-- YAML -added: v10.6.0 -napiVersion: 4 +added: v8.0.0 +napiVersion: 1 --> ```C @@ -1369,7 +1369,7 @@ napiVersion: 1 ```C NAPI_EXTERN napi_status napi_create_reference(napi_env env, napi_value value, - int initial_refcount, + uint32_t initial_refcount, napi_ref* result); ``` @@ -1412,7 +1412,7 @@ napiVersion: 1 ```C NAPI_EXTERN napi_status napi_reference_ref(napi_env env, napi_ref ref, - int* result); + uint32_t* result); ``` * `[in] env`: The environment that the API is invoked under. @@ -1433,7 +1433,7 @@ napiVersion: 1 ```C NAPI_EXTERN napi_status napi_reference_unref(napi_env env, napi_ref ref, - int* result); + uint32_t* result);); ``` * `[in] env`: The environment that the API is invoked under. @@ -1840,6 +1840,7 @@ structure, in most cases using a `TypedArray` will suffice. #### napi_create_date <!-- YAML added: v11.11.0 +napiVersion: 5 --> ```C @@ -2519,6 +2520,7 @@ This API returns various properties of a `DataView`. #### napi_get_date_value <!-- YAML added: v11.11.0 +napiVersion: 5 --> ```C @@ -3139,6 +3141,7 @@ This API checks if the `Object` passed in is a buffer. ### napi_is_date <!-- YAML added: v11.11.0 +napiVersion: 5 --> ```C @@ -3829,12 +3832,12 @@ napiVersion: 1 --> ```C -napi_status napi_call_function(napi_env env, - napi_value recv, - napi_value func, - int argc, - const napi_value* argv, - napi_value* result) +NAPI_EXTERN napi_status napi_call_function(napi_env env, + napi_value recv, + napi_value func, + size_t argc, + const napi_value* argv, + napi_value* result); ``` * `[in] env`: The environment that the API is invoked under. @@ -4299,6 +4302,7 @@ JavaScript object becomes garbage-collected. <!-- YAML added: v8.0.0 +napiVersion: 5 --> ```C @@ -4565,13 +4569,13 @@ changes: --> ```C -napi_status napi_make_callback(napi_env env, - napi_async_context async_context, - napi_value recv, - napi_value func, - int argc, - const napi_value* argv, - napi_value* result) +NAPI_EXTERN napi_status napi_make_callback(napi_env env, + napi_async_context async_context, + napi_value recv, + napi_value func, + size_t argc, + const napi_value* argv, + napi_value* result); ``` * `[in] env`: The environment that the API is invoked under. |