Skip to content

Commit

Permalink
doc: refer to TypedArray and ArrayBuffer from Array
Browse files Browse the repository at this point in the history
Add a blurb to the `Napi::Array` documentation that refers readers to
`Napi::TypedArray` and `Napi::ArrayBuffer` for using arrays with large
amounts of data.

PR-URL: nodejs/node-addon-api#465
Reviewed-By: Michael Dawson <[email protected]>
 Reviewed-By: Nicola Del Gobbo <[email protected]>
  • Loading branch information
wroy7860 committed Apr 4, 2019
1 parent a2e2825 commit 288fa75
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/basic_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,12 @@ The value is not coerced to a string.
Arrays are native representations of JavaScript Arrays. `Napi::Array` is a wrapper
around `napi_value` representing a JavaScript Array.
[`Napi::TypedArray`][] and [`Napi::ArrayBuffer`][] correspond to JavaScript data
types such as [`Int32Array`][] and [`ArrayBuffer`][], respectively, that can be
used for transferring large amounts of data from JavaScript to the native side.
An example illustrating the use of a JavaScript-provided `ArrayBuffer` in native
code is available [here](https://github.com/nodejs/node-addon-examples/tree/master/array_buffer_to_native/node-addon-api).
### Constructor
```cpp
Napi::Array::Array();
Expand Down Expand Up @@ -402,3 +408,8 @@ This can execute JavaScript code implicitly according to JavaScript semantics.
If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not
being used, callers should check the result of `Env::IsExceptionPending` before
attempting to use the returned value.

[`Napi::TypedArray`]: ./typed_array.md
[`Napi::ArrayBuffer`]: ./array_buffer.md
[`Int32Array`]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int32Array
[`ArrayBuffer`]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer

0 comments on commit 288fa75

Please sign in to comment.