Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify behavior of napi_get_typedarray_info #32603

Closed
wants to merge 9 commits into from
3 changes: 2 additions & 1 deletion doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2532,7 +2532,8 @@ napi_status napi_get_typedarray_info(napi_env env,
* `[out] length`: The number of elements in the `TypedArray`.
* `[out] data`: The data buffer underlying the `TypedArray` adjusted by
the `byte_offset` value so that it points to the first element in the
`TypedArray`.
`TypedArray`. If the length of the array is 0 this may be NULL or any
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
other pointer value.
* `[out] arraybuffer`: The `ArrayBuffer` underlying the `TypedArray`.
* `[out] byte_offset`: The byte offset within the underlying native array
at which the first element of the arrays is located. The value for the data
Expand Down