node-api,doc: document parms which can be optional

Fixes: https://github.com/nodejs/abi-stable-node/issues/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: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Michael Dawson committed 2021-12-03 16:19:00 -05:00
1 parent fd66ae881b
commit ea65e1f6bb
1 file changed
+4 -2
+4 -2
View File
@@ -4735,7 +4735,8 @@ napi_status napi_new_instance(napi_env env,
as a constructor.
* `[in] argc`: The count of elements in the `argv` array.
* `[in] argv`: Array of JavaScript values as `napi_value` representing the
arguments to the constructor.
arguments to the constructor. If `argc` is zero this parameter may be
omitted by passing in `NULL`.
* `[out] result`: `napi_value` representing the JavaScript object returned,
which in this case is the constructed object.
@@ -5512,7 +5513,8 @@ NAPI_EXTERN napi_status napi_make_callback(napi_env env,
* `[in] func`: `napi_value` representing the JavaScript function to be invoked.
* `[in] argc`: The count of elements in the `argv` array.
* `[in] argv`: Array of JavaScript values as `napi_value` representing the
arguments to the function.
arguments to the function. If `argc` is zero this parameter may be
omitted by passing in `NULL`.
* `[out] result`: `napi_value` representing the JavaScript object returned.
Returns `napi_ok` if the API succeeded.