Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix up N-API doc #30254

Closed
wants to merge 2 commits into from
Closed

doc: fix up N-API doc #30254

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eacb8a1
doc: fix up N-API doc
mhdawson Nov 4, 2019
8ea69b3
squash: address changes
mhdawson Nov 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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);
```

Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -1840,6 +1840,7 @@ structure, in most cases using a `TypedArray` will suffice.
#### napi_create_date
<!-- YAML
added: v11.11.0
napiVersion: 5
-->

```C
Expand Down Expand Up @@ -2519,6 +2520,7 @@ This API returns various properties of a `DataView`.
#### napi_get_date_value
<!-- YAML
added: v11.11.0
napiVersion: 5
-->

```C
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -4299,6 +4302,7 @@ JavaScript object becomes garbage-collected.

<!-- YAML
added: v8.0.0
napiVersion: 5
-->

```C
Expand Down Expand Up @@ -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.
Expand Down