Skip to content

Commit

Permalink
node-api,doc: document parms which can be optional
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
mhdawson authored and danielleadams committed Jan 31, 2022
1 parent c3b7de5 commit 8ec81ea
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 8ec81ea

Please sign in to comment.