Skip to content

Commit 8d53024

Browse files
mhdawsontargos
authored andcommitted
doc: improve consistency in usage of NULL
- add backticks around use of NULL - convert from null to NULL where we mean NULL Signed-off-by: Michael Dawson <[email protected]> PR-URL: #32726 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Christopher Hiller <[email protected]>
1 parent 6f1931d commit 8d53024

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

doc/api/n-api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -859,7 +859,7 @@ SemVer applying. In order to support this model with N-API, both
859859
in internal functionality and for module specific functionality
860860
(as its good practice), the `throw_` and `create_` functions
861861
take an optional code parameter which is the string for the code
862-
to be added to the error object. If the optional parameter is NULL
862+
to be added to the error object. If the optional parameter is `NULL`
863863
then no code will be associated with the error. If a code is provided,
864864
the name associated with the error is also updated to be:
865865

@@ -1057,7 +1057,7 @@ napi_status napi_get_and_clear_last_exception(napi_env env,
10571057
```
10581058

10591059
* `[in] env`: The environment that the API is invoked under.
1060-
* `[out] result`: The exception if one is pending, NULL otherwise.
1060+
* `[out] result`: The exception if one is pending, `NULL` otherwise.
10611061

10621062
Returns `napi_ok` if the API succeeded.
10631063

@@ -1349,7 +1349,7 @@ then be modified through [`napi_reference_ref`][] and
13491349
[`napi_reference_unref`][]. If an object is collected while the count
13501350
for a reference is 0, all subsequent calls to
13511351
get the object associated with the reference [`napi_get_reference_value`][]
1352-
will return NULL for the returned `napi_value`. An attempt to call
1352+
will return `NULL` for the returned `napi_value`. An attempt to call
13531353
[`napi_reference_ref`][] for a reference whose object has been collected
13541354
will result in an error.
13551355

@@ -1472,7 +1472,7 @@ Returns `napi_ok` if the API succeeded.
14721472

14731473
If still valid, this API returns the `napi_value` representing the
14741474
JavaScript `Object` associated with the `napi_ref`. Otherwise, result
1475-
will be NULL.
1475+
will be `NULL`.
14761476

14771477
### Cleanup on exit of the current Node.js instance
14781478

@@ -1548,7 +1548,7 @@ napi_value Init(napi_env env, napi_value exports);
15481548

15491549
The return value from `Init` is treated as the `exports` object for the module.
15501550
The `Init` method is passed an empty object via the `exports` parameter as a
1551-
convenience. If `Init` returns NULL, the parameter passed as `exports` is
1551+
convenience. If `Init` returns `NULL`, the parameter passed as `exports` is
15521552
exported by the module. N-API modules cannot modify the `module` object but can
15531553
specify anything as the `exports` property of the module.
15541554

@@ -2826,7 +2826,7 @@ napi_status napi_get_value_string_latin1(napi_env env,
28262826

28272827
* `[in] env`: The environment that the API is invoked under.
28282828
* `[in] value`: `napi_value` representing JavaScript string.
2829-
* `[in] buf`: Buffer to write the ISO-8859-1-encoded string into. If NULL is
2829+
* `[in] buf`: Buffer to write the ISO-8859-1-encoded string into. If `NULL` is
28302830
passed in, the length of the string (in bytes) is returned.
28312831
* `[in] bufsize`: Size of the destination buffer. When this value is
28322832
insufficient, the returned string will be truncated.
@@ -2855,7 +2855,7 @@ napi_status napi_get_value_string_utf8(napi_env env,
28552855

28562856
* `[in] env`: The environment that the API is invoked under.
28572857
* `[in] value`: `napi_value` representing JavaScript string.
2858-
* `[in] buf`: Buffer to write the UTF8-encoded string into. If NULL is passed
2858+
* `[in] buf`: Buffer to write the UTF8-encoded string into. If `NULL` is passed
28592859
in, the length of the string (in bytes) is returned.
28602860
* `[in] bufsize`: Size of the destination buffer. When this value is
28612861
insufficient, the returned string will be truncated.
@@ -2883,7 +2883,7 @@ napi_status napi_get_value_string_utf16(napi_env env,
28832883

28842884
* `[in] env`: The environment that the API is invoked under.
28852885
* `[in] value`: `napi_value` representing JavaScript string.
2886-
* `[in] buf`: Buffer to write the UTF16-LE-encoded string into. If NULL is
2886+
* `[in] buf`: Buffer to write the UTF16-LE-encoded string into. If `NULL` is
28872887
passed in, the length of the string (in 2-byte code units) is returned.
28882888
* `[in] bufsize`: Size of the destination buffer. When this value is
28892889
insufficient, the returned string will be truncated.

0 commit comments

Comments
 (0)