Commit 6b6e1d0
node-api,doc: document parms which can be optional
Fixes: nodejs/abi-stable-node#252
I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.
Signed-off-by: Michael Dawson <mdawson@devrus.com>
PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
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 fb8f2e9 commit 6b6e1d0
1 file changed
Lines changed: 4 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4735,7 +4735,8 @@ napi_status napi_new_instance(napi_env env, | |||
| 4735 | 4735 | as a constructor. | |
| 4736 | 4736 | * `[in] argc`: The count of elements in the `argv` array. | |
| 4737 | 4737 | * `[in] argv`: Array of JavaScript values as `napi_value` representing the | |
| 4738 | - arguments to the constructor. | ||
| 4738 | + arguments to the constructor. If `argc` is zero this parameter may be | ||
| 4739 | + omitted by passing in `NULL`. | ||
| 4739 | 4740 | * `[out] result`: `napi_value` representing the JavaScript object returned, | |
| 4740 | 4741 | which in this case is the constructed object. | |
| 4741 | 4742 | ||
@@ -5512,7 +5513,8 @@ NAPI_EXTERN napi_status napi_make_callback(napi_env env, | |||
| 5512 | 5513 | * `[in] func`: `napi_value` representing the JavaScript function to be invoked. | |
| 5513 | 5514 | * `[in] argc`: The count of elements in the `argv` array. | |
| 5514 | 5515 | * `[in] argv`: Array of JavaScript values as `napi_value` representing the | |
| 5515 | - arguments to the function. | ||
| 5516 | + arguments to the function. If `argc` is zero this parameter may be | ||
| 5517 | + omitted by passing in `NULL`. | ||
| 5516 | 5518 | * `[out] result`: `napi_value` representing the JavaScript object returned. | |
| 5517 | 5519 | ||
| 5518 | 5520 | Returns `napi_ok` if the API succeeded. | |
0 commit comments