1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify behavior of napi_get_typedarray_info

Browse Source 
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>

Fixes: https://github.com/nodejs/node/issues/32089

PR-URL: https://github.com/nodejs/node/pull/32603
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Michael Dawson 2020-04-01 17:23:32 -04:00
parent 6ec0285478
commit 2681cba62e
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/n-api.md
View File

@ -2447,7 +2447,8 @@ napi_status napi_get_arraybuffer_info(napi_env env,
* `[in] env`: The environment that the API is invoked under. * `[in] env`: The environment that the API is invoked under.
* `[in] arraybuffer`: `napi_value` representing the `ArrayBuffer` being queried. * `[in] arraybuffer`: `napi_value` representing the `ArrayBuffer` being queried.
* `[out] data`: The underlying data buffer of the `ArrayBuffer`. * `[out] data`: The underlying data buffer of the `ArrayBuffer`. If byte_length
is `0`, this may be `NULL` or any other pointer value.
* `[out] byte_length`: Length in bytes of the underlying data buffer. * `[out] byte_length`: Length in bytes of the underlying data buffer.
Returns `napi_ok` if the API succeeded. Returns `napi_ok` if the API succeeded.
@ -2479,6 +2480,7 @@ napi_status napi_get_buffer_info(napi_env env,
* `[in] env`: The environment that the API is invoked under. * `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing the `node::Buffer` being queried. * `[in] value`: `napi_value` representing the `node::Buffer` being queried.
* `[out] data`: The underlying data buffer of the `node::Buffer`. * `[out] data`: The underlying data buffer of the `node::Buffer`.
If length is `0`, this may be `NULL` or any other pointer value.
* `[out] length`: Length in bytes of the underlying data buffer. * `[out] length`: Length in bytes of the underlying data buffer.
Returns `napi_ok` if the API succeeded. Returns `napi_ok` if the API succeeded.
@ -2532,7 +2534,8 @@ napi_status napi_get_typedarray_info(napi_env env,
* `[out] length`: The number of elements in the `TypedArray`. * `[out] length`: The number of elements in the `TypedArray`.
* `[out] data`: The data buffer underlying the `TypedArray` adjusted by * `[out] data`: The data buffer underlying the `TypedArray` adjusted by
the `byte_offset` value so that it points to the first element in the 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 other pointer value.
* `[out] arraybuffer`: The `ArrayBuffer` underlying the `TypedArray`. * `[out] arraybuffer`: The `ArrayBuffer` underlying the `TypedArray`.
* `[out] byte_offset`: The byte offset within the underlying native array * `[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 at which the first element of the arrays is located. The value for the data
@ -2567,6 +2570,7 @@ napi_status napi_get_dataview_info(napi_env env,
properties to query. properties to query.
* `[out] byte_length`: `Number` of bytes in the `DataView`. * `[out] byte_length`: `Number` of bytes in the `DataView`.
* `[out] data`: The data buffer underlying the `DataView`. * `[out] data`: The data buffer underlying the `DataView`.
If byte_length is `0`, this may be `NULL` or any other pointer value.
* `[out] arraybuffer`: `ArrayBuffer` underlying the `DataView`. * `[out] arraybuffer`: `ArrayBuffer` underlying the `DataView`.
* `[out] byte_offset`: The byte offset within the data buffer from which * `[out] byte_offset`: The byte offset within the data buffer from which
to start projecting the `DataView`. to start projecting the `DataView`.