Skip to content

doc: fix doc for napi_get_typedarray_info

Rodrigo Muino Tomonari requested to merge github/fork/mhdawson/napi-typedarray into master

The data pointer returned for the typedarray has already been adjusted by the offset so it does not point to the start of the buffer, instead id points to the start of the first element.

I think we probably would have liked it to point to the start of the buffer, but we can't change as that would be a breaking change.

Update the doc to match the implementation.

Fixes: https://github.com/nodejs/node-addon-api/issues/244

Checklist
  • [X ] make -j4 test (UNIX), or vcbuild test (Windows) passes .- [X] documentation is changed or added
  • commit message follows commit guidelines

Merge request reports