diff --git a/doc/api/n-api.md b/doc/api/n-api.md index a8d1ae46d09cdc..5a98b93d1f7b93 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -1750,10 +1750,15 @@ napi_status napi_get_typedarray_info(napi_env env, properties to query. - `[out] type`: Scalar datatype of the elements within the `TypedArray`. - `[out] length`: The number of elements in the `TypedArray`. -- `[out] data`: The data buffer underlying 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`. - `[out] arraybuffer`: The `ArrayBuffer` underlying the `TypedArray`. -- `[out] byte_offset`: The byte offset within the data buffer from which -to start projecting 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 +parameter has already been adjusted so that data points to the first element +in the array. Therefore, the first byte of the native array would be at +data - `byte_offset`. Returns `napi_ok` if the API succeeded.