mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
Code Issues Releases Activity

doc: fix up N-API doc

Browse Source 
* 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>
This commit is contained in:
Michael Dawson 2019-11-04 16:38:45 -05:00 committed by Kamat, Trivikram
parent 3d926898db
commit 1e0679e56d
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/api/n-api.md
View File

@ -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.