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.

Sign up for GitHub

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
Closed

doc: clarify behavior of napi_get_typedarray_info #32603

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
90bcb94
doc: clarify behavior of napi_get_typedarray_info
mhdawson Apr 1, 2020
f9bf2e4
squash:address comments
mhdawson Apr 2, 2020
ee1222e
fixup! doc: clarify behavior of napi_get_typedarray_info
addaleax Apr 5, 2020
537e0ac
Update doc/api/n-api.md
mhdawson Apr 8, 2020
f385cda
Update doc/api/n-api.md
mhdawson Apr 8, 2020
49f497d
Update doc/api/n-api.md
mhdawson Apr 8, 2020
5fbd1f0
Update doc/api/n-api.md
mhdawson Apr 8, 2020
0fc56c5
squash: address comments
mhdawson Apr 8, 2020
c83af74
squash: address comments
mhdawson Apr 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions doc/api/n-api.md
View file
Open in desktop
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.
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
* `[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.
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
* `[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
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 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.
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
* `[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