Skip to content

doc: add an example for util.types.isExternal #31173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
HarshithaKP wants to merge 2 commits into from
+30 −0
Closed

doc: add an example for util.types.isExternal #31173

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa6096d
doc: add an example for util.types.isExternal
HarshithaKP Jan 3, 2020
a4648ee
fixup: address review comments
HarshithaKP Jan 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: add an example for util.types.isExternal 
added usage example for util.types.isExternal
which was missing owing to the complexity.
Used a combination of n-api and js to demonstrate
usage of the api.

Fixes: #20604
  • Loading branch information
@HarshithaKP
HarshithaKP committed Jan 10, 2020
commit aa6096d3c90b23e4430ef4607b34d748144623b7
30 changes: 30 additions & 0 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1399,6 +1399,35 @@ properties. Such objects are created either by Node.js internals or native
addons. In JavaScript, they are [frozen][`Object.freeze()`] objects with a
`null` prototype.

```c++
Comment thread
BridgeAR marked this conversation as resolved.
Outdated
#include <js_native_api.h>
#include <string.h>
Comment thread
BridgeAR marked this conversation as resolved.
Outdated
napi_value result;
static napi_value MyNapi(napi_env env, napi_callback_info info) {
int* raw = (int*) malloc(1024);
napi_status status = napi_create_external(env, (void*) raw, NULL, NULL, &result);
if (status != napi_ok) {
napi_throw_error(env, NULL, "napi_create_external failed");
return NULL;
}
return result;
}
...
DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
...
```

```js
Comment thread
BridgeAR marked this conversation as resolved.
Outdated
const native = require('napi_addon.node');
const data = native.myNapi();
util.types.isExternal(data); // returns true
util.types.isExternal(0); // returns false
util.types.isExternal(new String('foo')); // returns false
```

For further information on `napi_create_external`, refer to
Comment thread
BridgeAR marked this conversation as resolved.
Outdated
[`napi_create_external()`][].

### `util.types.isFloat32Array(value)`
<!-- YAML
added: v10.0.0
Expand Down Expand Up @@ -2358,5 +2387,6 @@ util.log('Timestamped message.');
[default sort]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
[global symbol registry]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for
[list of deprecated APIS]: deprecations.html#deprecations_list_of_deprecated_apis
[`napi_create_external()`]: n-api.html#n_api_napi_create_external
[semantically incompatible]: https://github.com/nodejs/node/issues/4179
[util.inspect.custom]: #util_util_inspect_custom