Commit 4724e07
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 <legendecas@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent e2c9e1c commit 4724e07
1 file changed
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2821,6 +2821,8 @@ Returns `napi_ok` if the API succeeded. | |||
| 2821 | 2821 | ||
| 2822 | 2822 | This API returns various properties of a typed array. | |
| 2823 | 2823 | ||
| 2824 | + Any of the out parameters may be `NULL` if that property is unneeded. | ||
| 2825 | + | ||
| 2824 | 2826 | *Warning*: Use caution while using this API since the underlying data buffer | |
| 2825 | 2827 | is managed by the VM. | |
| 2826 | 2828 | ||
@@ -2851,6 +2853,8 @@ napi_status napi_get_dataview_info(napi_env env, | |||
| 2851 | 2853 | ||
| 2852 | 2854 | Returns `napi_ok` if the API succeeded. | |
| 2853 | 2855 | ||
| 2856 | + Any of the out parameters may be `NULL` if that property is unneeded. | ||
| 2857 | + | ||
| 2854 | 2858 | This API returns various properties of a `DataView`. | |
| 2855 | 2859 | ||
| 2856 | 2860 | #### napi_get_date_value | |
0 commit comments