Skip to content

Commit b8afe57

Browse files
mhdawsonMylesBorins
authored andcommitted
doc: fix up N-API doc
* Add missing N-API version info * Fix N-API version info for napi_extended_error_info PR-URL: #30254 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Jiawen Geng <[email protected]>
1 parent b558d94 commit b8afe57

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

doc/api/n-api.md

+22-18
Original file line numberDiff line numberDiff line change
@@ -729,8 +729,8 @@ is provided which returns a `napi_extended_error_info` structure.
729729
The format of the `napi_extended_error_info` structure is as follows:
730730

731731
<!-- YAML
732-
added: v10.6.0
733-
napiVersion: 4
732+
added: v8.0.0
733+
napiVersion: 1
734734
-->
735735

736736
```C
@@ -1369,7 +1369,7 @@ napiVersion: 1
13691369
```C
13701370
NAPI_EXTERN napi_status napi_create_reference(napi_env env,
13711371
napi_value value,
1372-
int initial_refcount,
1372+
uint32_t initial_refcount,
13731373
napi_ref* result);
13741374
```
13751375

@@ -1412,7 +1412,7 @@ napiVersion: 1
14121412
```C
14131413
NAPI_EXTERN napi_status napi_reference_ref(napi_env env,
14141414
napi_ref ref,
1415-
int* result);
1415+
uint32_t* result);
14161416
```
14171417

14181418
* `[in] env`: The environment that the API is invoked under.
@@ -1433,7 +1433,7 @@ napiVersion: 1
14331433
```C
14341434
NAPI_EXTERN napi_status napi_reference_unref(napi_env env,
14351435
napi_ref ref,
1436-
int* result);
1436+
uint32_t* result););
14371437
```
14381438

14391439
* `[in] env`: The environment that the API is invoked under.
@@ -1840,6 +1840,7 @@ structure, in most cases using a `TypedArray` will suffice.
18401840
#### napi_create_date
18411841
<!-- YAML
18421842
added: v11.11.0
1843+
napiVersion: 5
18431844
-->
18441845

18451846
```C
@@ -2519,6 +2520,7 @@ This API returns various properties of a `DataView`.
25192520
#### napi_get_date_value
25202521
<!-- YAML
25212522
added: v11.11.0
2523+
napiVersion: 5
25222524
-->
25232525

25242526
```C
@@ -3139,6 +3141,7 @@ This API checks if the `Object` passed in is a buffer.
31393141
### napi_is_date
31403142
<!-- YAML
31413143
added: v11.11.0
3144+
napiVersion: 5
31423145
-->
31433146

31443147
```C
@@ -3829,12 +3832,12 @@ napiVersion: 1
38293832
-->
38303833

38313834
```C
3832-
napi_status napi_call_function(napi_env env,
3833-
napi_value recv,
3834-
napi_value func,
3835-
int argc,
3836-
const napi_value* argv,
3837-
napi_value* result)
3835+
NAPI_EXTERN napi_status napi_call_function(napi_env env,
3836+
napi_value recv,
3837+
napi_value func,
3838+
size_t argc,
3839+
const napi_value* argv,
3840+
napi_value* result);
38383841
```
38393842

38403843
* `[in] env`: The environment that the API is invoked under.
@@ -4299,6 +4302,7 @@ JavaScript object becomes garbage-collected.
42994302

43004303
<!-- YAML
43014304
added: v8.0.0
4305+
napiVersion: 5
43024306
-->
43034307

43044308
```C
@@ -4565,13 +4569,13 @@ changes:
45654569
-->
45664570

45674571
```C
4568-
napi_status napi_make_callback(napi_env env,
4569-
napi_async_context async_context,
4570-
napi_value recv,
4571-
napi_value func,
4572-
int argc,
4573-
const napi_value* argv,
4574-
napi_value* result)
4572+
NAPI_EXTERN napi_status napi_make_callback(napi_env env,
4573+
napi_async_context async_context,
4574+
napi_value recv,
4575+
napi_value func,
4576+
size_t argc,
4577+
const napi_value* argv,
4578+
napi_value* result);
45754579
```
45764580

45774581
* `[in] env`: The environment that the API is invoked under.

0 commit comments

Comments
 (0)