Skip to content

Clarify Node.js 22 server thread affinity #586

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

Draft
Felipellira wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Clarify Node.js 22 server thread affinity #586

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
8 changes: 7 additions & 1 deletion content/docs/scripting-manual/runtimes/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@ Gotchas
-------

### Thread affinity
In the Node.js runtime, any callbacks that are triggered by Node.js will _run on a separate thread_ hosting the libuv
The workaround in this section applies to the default Node.js 16 server runtime.

In the Node.js 16 runtime, any callbacks that are triggered by Node.js will _run on a separate thread_ hosting the libuv
event loop. Since CitizenFX server natives can only be called on the main game thread, trying to invoke any will likely
lead to an error saying 'No current resource manager'.

Expand Down Expand Up @@ -140,6 +142,10 @@ fs.readFile(`${root}/test.txt`, { encoding: 'utf8' }, (err, data) => {
Note that when nesting Node.js callbacks and _not_ using natives in between, you don't need to schedule the code back to
the main thread, and it is recommended that you don't do so for the sake of performance.

When using Node.js 22 (`node_version '22'`), this thread-affinity workaround is no longer needed for server natives or
event functions after Node.js I/O callbacks or awaited Node.js operations. Use `setImmediate` there only when you
intentionally want to defer work to a later tick.

Functions in JavaScript
-----------------------

Expand Down