diff options
| author | Gabriel Schulhof <gabriel.schulhof@intel.com> | 2018-04-28 17:38:09 -0400 |
|---|---|---|
| committer | Gabriel Schulhof <gabriel.schulhof@intel.com> | 2018-04-30 16:29:03 -0400 |
| commit | d3255cad8e2a6ba03629903743e166401fc3597e (patch) | |
| tree | 749e103a2743acc73809f852e765c998eebfebc7 /doc/api/n-api.md | |
| parent | 80624314911c6cc3740ff88eea38ff2d0f8ab60e (diff) | |
| download | android-node-v8-d3255cad8e2a6ba03629903743e166401fc3597e.tar.gz android-node-v8-d3255cad8e2a6ba03629903743e166401fc3597e.tar.bz2 android-node-v8-d3255cad8e2a6ba03629903743e166401fc3597e.zip | |
n-api: document the look of napi_external values
Describe what JavaScript values of type `napi_external` look like in
JavaScript.
Fixes: https://github.com/nodejs/abi-stable-node/issues/306
PR-URL: https://github.com/nodejs/node/pull/20426
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/n-api.md')
| -rw-r--r-- | doc/api/n-api.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index bc0db26e35..1ad9312b19 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -1051,6 +1051,9 @@ the ECMAScript Language Specification. In addition to types in that section, `napi_valuetype` can also represent `Function`s and `Object`s with external data. +A JavaScript value of type `napi_external` appears in JavaScript as a plain +object such that no properties can be set on it, and no prototype. + #### napi_typedarray_type ```C typedef enum { |