Commit cf495a6
doc: clarify more optional parameters in node-api
Refs: nodejs/abi-stable-node#252
Signed-off-by: Michael Dawson <mdawson@devrus.com>
PR-URL: #40888
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>1 parent 3d593aa commit cf495a6
1 file changed
Lines changed: 5 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2216,6 +2216,7 @@ napi_status napi_create_arraybuffer(napi_env env, | |||
| 2216 | 2216 | * `[in] env`: The environment that the API is invoked under. | |
| 2217 | 2217 | * `[in] length`: The length in bytes of the array buffer to create. | |
| 2218 | 2218 | * `[out] data`: Pointer to the underlying byte buffer of the `ArrayBuffer`. | |
| 2219 | + `data` can optionally be ignored by passing `NULL`. | ||
| 2219 | 2220 | * `[out] result`: A `napi_value` representing a JavaScript `ArrayBuffer`. | |
| 2220 | 2221 | ||
| 2221 | 2222 | Returns `napi_ok` if the API succeeded. | |
@@ -2250,6 +2251,7 @@ napi_status napi_create_buffer(napi_env env, | |||
| 2250 | 2251 | * `[in] env`: The environment that the API is invoked under. | |
| 2251 | 2252 | * `[in] size`: Size in bytes of the underlying buffer. | |
| 2252 | 2253 | * `[out] data`: Raw pointer to the underlying buffer. | |
| 2254 | + `data` can optionally be ignored by passing `NULL`. | ||
| 2253 | 2255 | * `[out] result`: A `napi_value` representing a `node::Buffer`. | |
| 2254 | 2256 | ||
| 2255 | 2257 | Returns `napi_ok` if the API succeeded. | |
@@ -2277,6 +2279,7 @@ napi_status napi_create_buffer_copy(napi_env env, | |||
| 2277 | 2279 | of the new buffer). | |
| 2278 | 2280 | * `[in] data`: Raw pointer to the underlying buffer to copy from. | |
| 2279 | 2281 | * `[out] result_data`: Pointer to the new `Buffer`'s underlying data buffer. | |
| 2282 | + `result_data` can optionally be ignored by passing `NULL`. | ||
| 2280 | 2283 | * `[out] result`: A `napi_value` representing a `node::Buffer`. | |
| 2281 | 2284 | ||
| 2282 | 2285 | Returns `napi_ok` if the API succeeded. | |
@@ -4588,8 +4591,8 @@ napi_status napi_create_function(napi_env env, | |||
| 4588 | 4591 | ``` | |
| 4589 | 4592 | ||
| 4590 | 4593 | * `[in] env`: The environment that the API is invoked under. | |
| 4591 | - * `[in] utf8Name`: The name of the function encoded as UTF8. This is visible | ||
| 4592 | - within JavaScript as the new function object's `name` property. | ||
| 4594 | + * `[in] utf8Name`: Optional name of the function encoded as UTF8. This is | ||
| 4595 | + visible within JavaScript as the new function object's `name` property. | ||
| 4593 | 4596 | * `[in] length`: The length of the `utf8name` in bytes, or `NAPI_AUTO_LENGTH` if | |
| 4594 | 4597 | it is null-terminated. | |
| 4595 | 4598 | * `[in] cb`: The native function which should be called when this function | |
0 commit comments