Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements a utility for using
node:worker_modules
with a type-safe interface. Additionally, it implements:Example usage
Example of a worker module
First, define a worker module in a new file. This module is initialized in each worker thread, in an isolated environment. See the nodejs docs for more information.
The module must export two properties:
processTask
function that can be sync or async and can take any amount of argumentsworkerModule
constant that is assigned to the global module variable for this fileThese two properties can either be exported by themselves, or there can be a single default export object, e.g. a file named
example-worker.ts
:or
Example manager usage
Once a worker module is implemented, for example the above
example-worker.ts
module, then it can be used by theWorkerThreadManager
utility implemented in this PR.For example, here's a
main.ts
file usingWorkerThreadManager
to parallelize the code fromexample-worker.ts
using multiple logical CPUs:Notes:
WorkerThreadManager
is type-checked to ensure that the the module provided (in this caseexample-worker.ts
) implements the correct interface, andWorkerThreadManager.exec
function mirrors theprocessTask
function type from the given worker module.processTask
is a simple "multiply" function, however, in real-world usage this can be a CPU-intensive function (for example complex binary deserialization or cryptographic code), and it can also be a async/Promise.