Skip to content
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

doc: amplify warning for execute callback #28738

Closed
wants to merge 5 commits into from
Closed

doc: amplify warning for execute callback #28738

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8d6203f
doc: amplify warning for execute callback
mhdawson Jul 17, 2019
6dba467
Update doc/api/n-api.md
mhdawson Jul 18, 2019
4f74055
Update doc/api/n-api.md
mhdawson Jul 18, 2019
a9c7c03
squash:address comments
mhdawson Jul 18, 2019
ba95dfa
fixup! squash:address comments
Trott Jul 20, 2019
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
10 changes: 8 additions & 2 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,10 @@ typedef void (*napi_async_execute_callback)(napi_env env, void* data);
Implementations of this type of function should avoid making any N-API calls
that could result in the execution of JavaScript or interaction with
JavaScript objects. Most often, any code that needs to make N-API
calls should be made in `napi_async_complete_callback` instead.
calls should be made in `napi_async_complete_callback` instead. The
current recommendation is to avoid all usage of the
napi_env parameter in the execute callback as it will most
likely cause JavaScript to be executed.

#### napi_async_complete_callback
<!-- YAML
Expand Down Expand Up @@ -4027,7 +4030,10 @@ task respectively.
The `execute` function should avoid making any N-API calls
that could result in the execution of JavaScript or interaction with
JavaScript objects. Most often, any code that needs to make N-API
calls should be made in `complete` callback instead.
calls should be made in `complete` callback instead. The
current recommendation is to avoid all usage of the
napi_env parameter in the execute callback as it will most
likely cause JavaScript to be executed.

These functions implement the following interfaces:

Expand Down