doc: indicate n-api out params that may be NULL

This is useful information to have for applications that don't need to read the other properties. The implementation checks for `nullptr`, see: https://github.com/nodejs/node/blob/master/src/js_native_api_v8.cc#L2879 PR-URL: #40371 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Nov 4, 2021 · 4724e07 · 4724e07
1 parent e2c9e1c
commit 4724e07
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
@@ -2821,6 +2821,8 @@ Returns `napi_ok` if the API succeeded.
 
 This API returns various properties of a typed array.
 
+Any of the out parameters may be `NULL` if that property is unneeded.
+
 *Warning*: Use caution while using this API since the underlying data buffer
 is managed by the VM.
 
@@ -2851,6 +2853,8 @@ napi_status napi_get_dataview_info(napi_env env,
 
 Returns `napi_ok` if the API succeeded.
 
+Any of the out parameters may be `NULL` if that property is unneeded.
+
 This API returns various properties of a `DataView`.
 
 #### napi_get_date_value