Skip to content

Commit

Permalink
doc: updates examples to use NULL
Browse files Browse the repository at this point in the history
Examples in the N-API doc used a mix of nullptr and NULL.
We should be consistent and because N-API is a 'C' API I believe
using NULL is better.  This will avoid any potential confusion
as to whether N-API can be used with plain C.

PR-URL: #18008
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
  • Loading branch information
mhdawson authored and MylesBorins committed Jan 9, 2018
1 parent 72ed11a commit 83c725d
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -905,9 +905,9 @@ napi_value Init(napi_env env, napi_value exports) {
napi_status status;
napi_property_descriptor desc =
{"hello", Method, 0, 0, 0, napi_default, 0};
if (status != napi_ok) return nullptr;
if (status != napi_ok) return NULL;
status = napi_define_properties(env, exports, 1, &desc);
if (status != napi_ok) return nullptr;
if (status != napi_ok) return NULL;
return exports;
}
```
Expand All @@ -919,7 +919,7 @@ napi_value Init(napi_env env, napi_value exports) {
napi_value method;
napi_status status;
status = napi_create_function(env, "exports", Method, NULL, &method));
if (status != napi_ok) return nullptr;
if (status != napi_ok) return NULL;
return method;
}
```
Expand All @@ -932,21 +932,21 @@ For example, to define a class so that new instances can be created
napi_value Init(napi_env env, napi_value exports) {
napi_status status;
napi_property_descriptor properties[] = {
{ "value", nullptr, GetValue, SetValue, 0, napi_default, 0 },
{ "value", NULL, GetValue, SetValue, 0, napi_default, 0 },
DECLARE_NAPI_METHOD("plusOne", PlusOne),
DECLARE_NAPI_METHOD("multiply", Multiply),
};

napi_value cons;
status =
napi_define_class(env, "MyObject", New, nullptr, 3, properties, &cons);
if (status != napi_ok) return nullptr;
napi_define_class(env, "MyObject", New, NULL, 3, properties, &cons);
if (status != napi_ok) return NULL;

status = napi_create_reference(env, cons, 1, &constructor);
if (status != napi_ok) return nullptr;
if (status != napi_ok) return NULL;

status = napi_set_named_property(env, exports, "MyObject", cons);
if (status != napi_ok) return nullptr;
if (status != napi_ok) return NULL;

return exports;
}
Expand Down Expand Up @@ -2364,8 +2364,8 @@ if (status != napi_ok) return status;

// Set the properties
napi_property_descriptor descriptors[] = {
{ "foo", nullptr, 0, 0, 0, fooValue, napi_default, 0 },
{ "bar", nullptr, 0, 0, 0, barValue, napi_default, 0 }
{ "foo", NULL, 0, 0, 0, fooValue, napi_default, 0 },
{ "bar", NULL, 0, 0, 0, barValue, napi_default, 0 }
}
status = napi_define_properties(env,
obj,
Expand Down Expand Up @@ -2876,18 +2876,18 @@ object. A sample module might look as follows:
```C
napi_value SayHello(napi_env env, napi_callback_info info) {
printf("Hello\n");
return nullptr;
return NULL;
}

napi_value Init(napi_env env, napi_value exports) {
napi_status status;

napi_value fn;
status = napi_create_function(env, nullptr, 0, SayHello, nullptr, &fn);
if (status != napi_ok) return nullptr;
status = napi_create_function(env, NULL, 0, SayHello, NULL, &fn);
if (status != napi_ok) return NULL;

status = napi_set_named_property(env, exports, "sayHello", fn);
if (status != napi_ok) return nullptr;
if (status != napi_ok) return NULL;

return exports;
}
Expand Down Expand Up @@ -2952,7 +2952,7 @@ napi_status napi_get_new_target(napi_env env,
Returns `napi_ok` if the API succeeded.

This API returns the `new.target` of the constructor call. If the current
callback is not a constructor call, the result is `nullptr`.
callback is not a constructor call, the result is `NULL`.

### *napi_new_instance*
<!-- YAML
Expand Down Expand Up @@ -3034,7 +3034,7 @@ reference to the class constructor for later `instanceof` checks.
As an example:

```C
napi_value MyClass_constructor = nullptr;
napi_value MyClass_constructor = NULL;
status = napi_get_reference_value(env, MyClass::es_constructor, &MyClass_constructor);
assert(napi_ok == status);
bool is_instance = false;
Expand Down

0 comments on commit 83c725d

Please sign in to comment.