Skip to content

Commit

Permalink
doc: clarify behavior of napi_get_typedarray_info
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Dawson <[email protected]>

Fixes: #32089

PR-URL: #32603
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
  • Loading branch information
mhdawson authored and targos committed Apr 11, 2020
1 parent 0087eb1 commit 19deaa5
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2447,7 +2447,8 @@ napi_status napi_get_arraybuffer_info(napi_env env,

* `[in] env`: The environment that the API is invoked under.
* `[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.

Returns `napi_ok` if the API succeeded.
Expand Down Expand Up @@ -2479,6 +2480,7 @@ napi_status napi_get_buffer_info(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing the `node::Buffer` being queried.
* `[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.

Returns `napi_ok` if the API succeeded.
Expand Down Expand Up @@ -2532,7 +2534,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 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 Expand Up @@ -2567,6 +2570,7 @@ napi_status napi_get_dataview_info(napi_env env,
properties to query.
* `[out] byte_length`: `Number` of bytes in 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] byte_offset`: The byte offset within the data buffer from which
to start projecting the `DataView`.
Expand Down

0 comments on commit 19deaa5

Please sign in to comment.