worker-fn hides the complexity of communication between the JavaScript main
thread and Worker
threads, making it easy to call the functions defined in workers.
worker-fn allows you to create proxy functions in the main thread that
call corresponding worker functions defined in worker threads by sending
messages. These proxy functions maintain the same function signatures as the
corresponding worker functions (except that the return values of the proxy
functions are wrapped in Promises).
math.worker.js:
import { defineWorkerFn } from "worker-fn";
function add(a, b) {
return a + b;
}
function fib(n) {
return n <= 2 ? 1 : fib(n - 1) + fib(n - 2);
}
defineWorkerFn("add", add);
defineWorkerFn("fib", fib);math.js:
import { useWorkerFn } from "worker-fn";
const worker = new Worker(new URL("./math.worker.js", import.meta.url), {
type: "module",
});
const add = useWorkerFn("add", worker);
const fib = useWorkerFn("fib", worker);
console.log(await add(1, 2)); // 3
console.log(await fib(5)); // 5Example
math.worker.js:
import { defineWorkerFns } from "worker-fn";
const fns = {
add(a, b) {
return a + b;
},
fib(n) {
return n <= 2 ? 1 : fns.fib(n - 1) + fns.fib(n - 2);
},
};
defineWorkerFns(fns);math.js:
import { useWorkerFns } from "worker-fn";
const worker = new Worker(new URL("./math.worker.js", import.meta.url), {
type: "module",
});
const { add, fib } = useWorkerFns(worker);
console.log(await add(1, 2)); // 3
console.log(await fib(5)); // 5Example
math.worker.ts:
import { defineWorkerFn } from "worker-fn";
function add(a: number, b: number) {
return a + b;
}
function fib(n: number): number {
return n <= 2 ? 1 : fib(n - 1) + fib(n - 2);
}
defineWorkerFn("add", add);
defineWorkerFn("fib", fib);
export type Add = typeof add;
export type Fib = typeof fib;math.ts:
import { useWorkerFn } from "worker-fn";
import type { Add, Fib } from "./math.worker.ts";
const worker = new Worker(new URL("./math.worker.ts", import.meta.url), {
type: "module",
});
const add = useWorkerFn<Add>("add", worker);
const fib = useWorkerFn<Fib>("fib", worker);
console.log(await add(1, 2)); // 3
console.log(await fib(5)); // 5Example
math.worker.js:
import { parentPort } from "node:worker_threads";
import { defineWorkerFn } from "worker-fn";
function add(a, b) {
return a + b;
}
function fib(n) {
return n <= 2 ? 1 : fib(n - 1) + fib(n - 2);
}
defineWorkerFn("add", add, { port: parentPort });
defineWorkerFn("fib", fib, { port: parentPort });math.js:
import { Worker } from "node:worker_threads";
import { useWorkerFn } from "worker-fn";
const worker = new Worker(new URL("./math.worker.js", import.meta.url));
const add = useWorkerFn("add", worker);
const fib = useWorkerFn("fib", worker);
console.log(await add(1, 2)); // 3
console.log(await fib(5)); // 5worker-fn is published on both npm
and JSR. If you want to import worker-fn from
JSR, please refer to
this document.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent