Skip to content

[docs] Clarify async proxying behavior and add link to asyncify docs. #26150

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
dschuff merged 3 commits into from
Jan 22, 2026
Merged

[docs] Clarify async proxying behavior and add link to asyncify docs. #26150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
997b15b
[docs] Add xref link from proxying section to async section
dschuff Jan 22, 2026
33e6674
add more
dschuff Jan 22, 2026
de6cbb9
remove custom text on link
dschuff Jan 22, 2026
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
2 changes: 2 additions & 0 deletions site/source/docs/porting/asyncify.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,8 @@ You will see something like this:
That shows that the C code only continued to execute after the async JS
completed.

.. _marking_async_functions:

Marking JS library functions as async
#####################################

Expand Down
7 changes: 5 additions & 2 deletions site/source/docs/porting/pthreads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,11 @@ can also be used directly for more precise control over how work is run on
different threads.

When a JS library function is marked as both ``__proxy: 'sync'`` and ``__async:
'auto'`` the calling thread will block until the async operation on the
main thread is completed (i.e. the returned promise is resolved). This allows
'auto'``, it is expected to return a promise
(see :ref:`marking_async_functions`).
The calling thread will block until the async operation on the
main thread is completed (i.e. the returned promise is resolved), and the value
that the promise resolves to will be returned to the caller. This allows
functions that would require :ref:`ASYNCIFY` (when called from the main browser
thread) to be called without :ref:`ASYNCIFY` from a background thread. In other
words, background threads can block on proxied work even without :ref:`ASYNCIFY`
Expand Down