Skip to content

doc: edit addon text about event loop blocking #36448

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

Merged
Trott merged 1 commit into from
Dec 13, 2020
Merged

doc: edit addon text about event loop blocking #36448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions doc/api/addons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ involving knowledge of several components and APIs:
as interacting with the filesystem, sockets, timers, and system events. libuv
also provides a threading abstraction similar to POSIX threads for
more sophisticated asynchronous addons that need to move beyond the
standard event loop. Addon authors are encouraged to think about how to
standard event loop. Addon authors should
avoid blocking the event loop with I/O or other time-intensive tasks by
off-loading work via libuv to non-blocking system operations, worker threads
or a custom use of libuv's threads.
offloading work via libuv to non-blocking system operations, worker threads,
or a custom use of libuv threads.

* Internal Node.js libraries. Node.js itself exports C++ APIs that addons can
use, the most important of which is the `node::ObjectWrap` class.
Expand Down