summaryrefslogtreecommitdiff
path: root/doc/api/n-api.md
diff options
context:
space:
mode:
authorMichael Dawson <michael_dawson@ca.ibm.com>2018-05-09 15:58:38 -0400
committerAnna Henningsen <anna@addaleax.net>2018-05-14 18:36:16 +0200
commit2e4ee3dfa0676b639b23ed9e038ede313726af61 (patch)
treed9f040bf0436c7c7e57c10050a4bdbeafcccdfdd /doc/api/n-api.md
parent7dcfe72a2595331c2c5b2cc008bc2c63df6c95fa (diff)
downloadandroid-node-v8-2e4ee3dfa0676b639b23ed9e038ede313726af61.tar.gz
android-node-v8-2e4ee3dfa0676b639b23ed9e038ede313726af61.tar.bz2
android-node-v8-2e4ee3dfa0676b639b23ed9e038ede313726af61.zip
doc: fixup NODE_EXTERN -> NAPI_EXTERN
Seems like we missed updating doc when we changed from NODE_EXTERN to NAPI_EXTERN PR-URL: https://github.com/nodejs/node/pull/20641 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/n-api.md')
-rw-r--r--doc/api/n-api.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index 355519bc54..cb07e23e1e 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -343,7 +343,7 @@ TypeError [ERR_ERROR_1]
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_throw(napi_env env, napi_value error);
+NAPI_EXTERN napi_status napi_throw(napi_env env, napi_value error);
```
- `[in] env`: The environment that the API is invoked under.
- `[in] error`: The JavaScript value to be thrown.
@@ -357,7 +357,7 @@ This API throws the JavaScript value provided.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_throw_error(napi_env env,
+NAPI_EXTERN napi_status napi_throw_error(napi_env env,
const char* code,
const char* msg);
```
@@ -375,7 +375,7 @@ This API throws a JavaScript `Error` with the text provided.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_throw_type_error(napi_env env,
+NAPI_EXTERN napi_status napi_throw_type_error(napi_env env,
const char* code,
const char* msg);
```
@@ -393,7 +393,7 @@ This API throws a JavaScript `TypeError` with the text provided.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_throw_range_error(napi_env env,
+NAPI_EXTERN napi_status napi_throw_range_error(napi_env env,
const char* code,
const char* msg);
```
@@ -411,7 +411,7 @@ This API throws a JavaScript `RangeError` with the text provided.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_is_error(napi_env env,
+NAPI_EXTERN napi_status napi_is_error(napi_env env,
napi_value value,
bool* result);
```
@@ -429,7 +429,7 @@ This API queries a `napi_value` to check if it represents an error object.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_create_error(napi_env env,
+NAPI_EXTERN napi_status napi_create_error(napi_env env,
napi_value code,
napi_value msg,
napi_value* result);
@@ -450,7 +450,7 @@ This API returns a JavaScript `Error` with the text provided.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_create_type_error(napi_env env,
+NAPI_EXTERN napi_status napi_create_type_error(napi_env env,
napi_value code,
napi_value msg,
napi_value* result);
@@ -659,7 +659,7 @@ can only be called once.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_open_handle_scope(napi_env env,
+NAPI_EXTERN napi_status napi_open_handle_scope(napi_env env,
napi_handle_scope* result);
```
- `[in] env`: The environment that the API is invoked under.
@@ -674,7 +674,7 @@ This API open a new scope.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_close_handle_scope(napi_env env,
+NAPI_EXTERN napi_status napi_close_handle_scope(napi_env env,
napi_handle_scope scope);
```
- `[in] env`: The environment that the API is invoked under.
@@ -692,7 +692,7 @@ This API can be called even if there is a pending JavaScript exception.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status
+NAPI_EXTERN napi_status
napi_open_escapable_handle_scope(napi_env env,
napi_handle_scope* result);
```
@@ -709,7 +709,7 @@ to the outer scope.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status
+NAPI_EXTERN napi_status
napi_close_escapable_handle_scope(napi_env env,
napi_handle_scope scope);
```
@@ -793,7 +793,7 @@ individual count.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_create_reference(napi_env env,
+NAPI_EXTERN napi_status napi_create_reference(napi_env env,
napi_value value,
int initial_refcount,
napi_ref* result);
@@ -815,7 +815,7 @@ to the `Object` passed in.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_delete_reference(napi_env env, napi_ref ref);
+NAPI_EXTERN napi_status napi_delete_reference(napi_env env, napi_ref ref);
```
- `[in] env`: The environment that the API is invoked under.
@@ -832,7 +832,7 @@ This API can be called even if there is a pending JavaScript exception.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_reference_ref(napi_env env,
+NAPI_EXTERN napi_status napi_reference_ref(napi_env env,
napi_ref ref,
int* result);
```
@@ -850,7 +850,7 @@ passed in and returns the resulting reference count.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_reference_unref(napi_env env,
+NAPI_EXTERN napi_status napi_reference_unref(napi_env env,
napi_ref ref,
int* result);
```
@@ -868,7 +868,7 @@ passed in and returns the resulting reference count.
added: v8.0.0
-->
```C
-NODE_EXTERN napi_status napi_get_reference_value(napi_env env,
+NAPI_EXTERN napi_status napi_get_reference_value(napi_env env,
napi_ref ref,
napi_value* result);
```