Skip to content

Commit 47a98b3

Browse files
committed
doc: explain napi_run_script
1 parent 49fb529 commit 47a98b3

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/api/n-api.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4932,6 +4932,19 @@ NAPI_EXTERN napi_status napi_run_script(napi_env env,
49324932
* `[in] script`: A JavaScript string containing the script to execute.
49334933
* `[out] result`: The value resulting from having executed the script.
49344934

4935+
This function executes a string of JavaScript code and returns its result with
4936+
the following caveats:
4937+
4938+
* Unlike `eval`, this function does not allow the script to access the current
4939+
lexical scope, and therefore also does not allow to access the
4940+
[module scope][], meaning that pseudo-globals such as `require` will not be
4941+
available.
4942+
* The script can access the [global scope][]. Function and `var` declarations
4943+
in the script will be added to the [`global`][] object. Variable declarations
4944+
made using `let` and `const` will be visible globally, but will not be added
4945+
to the [`global`][] object.
4946+
* The value of `this` is [`global`][] within the script.
4947+
49354948
## libuv event loop
49364949

49374950
N-API provides a function for getting the current event loop associated with
@@ -5293,6 +5306,7 @@ This API may only be called from the main thread.
52935306
[Xcode]: https://developer.apple.com/xcode/
52945307
[`Number.MAX_SAFE_INTEGER`]: https://tc39.github.io/ecma262/#sec-number.max_safe_integer
52955308
[`Number.MIN_SAFE_INTEGER`]: https://tc39.github.io/ecma262/#sec-number.min_safe_integer
5309+
[`global`]: globals.html#globals_global
52965310
[`init` hooks]: async_hooks.html#async_hooks_init_asyncid_type_triggerasyncid_resource
52975311
[`napi_add_finalizer`]: #n_api_napi_add_finalizer
52985312
[`napi_async_init`]: #n_api_napi_async_init
@@ -5343,6 +5357,8 @@ This API may only be called from the main thread.
53435357
[async_hooks `type`]: async_hooks.html#async_hooks_type
53445358
[context-aware addons]: addons.html#addons_context_aware_addons
53455359
[docs]: https://github.com/nodejs/node-addon-api#api-documentation
5360+
[global scope]: globals.html
5361+
[module scope]: modules.html#modules_the_module_scope
53465362
[node-addon-api]: https://github.com/nodejs/node-addon-api
53475363
[node-gyp]: https://github.com/nodejs/node-gyp
53485364
[node-pre-gyp]: https://github.com/mapbox/node-pre-gyp

0 commit comments

Comments
 (0)