summaryrefslogtreecommitdiff
path: root/doc/api/n-api.md
diff options
context:
space:
mode:
authorGabriel Schulhof <gabriel.schulhof@intel.com>2018-05-09 10:24:01 -0400
committerGabriel Schulhof <gabriel.schulhof@intel.com>2018-05-09 13:44:50 -0400
commit06dc96fa7cc91c9ba4c776f73fef0e509f853ab2 (patch)
tree8520334011c4fdcdbfdc0fb71ec378a7a5c290d3 /doc/api/n-api.md
parentfacb2c53c2bb98d14a2f94844ceaacfc4c606e68 (diff)
downloadandroid-node-v8-06dc96fa7cc91c9ba4c776f73fef0e509f853ab2.tar.gz
android-node-v8-06dc96fa7cc91c9ba4c776f73fef0e509f853ab2.tar.bz2
android-node-v8-06dc96fa7cc91c9ba4c776f73fef0e509f853ab2.zip
doc: fix missing napi_get_typedarray_info() param
Also, make the type name notation more consistent. PR-URL: https://github.com/nodejs/node/pull/20631 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/n-api.md')
-rw-r--r--doc/api/n-api.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index 17958c8daf..739213c155 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -1697,8 +1697,9 @@ napi_status napi_get_typedarray_info(napi_env env,
- `[in] typedarray`: `napi_value` representing the `TypedArray` whose
properties to query.
- `[out] type`: Scalar datatype of the elements within the `TypedArray`.
-- `[out] length`: `Number` of elements in the `TypedArray`.
-- `[out] data`: The data buffer underlying the typed array.
+- `[out] length`: The number of elements in the `TypedArray`.
+- `[out] data`: The data buffer underlying 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`.