Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mys1024/worker-fn
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.
https://github.com/mys1024/worker-fn
frontend function jsr npm package web webworker
Last synced: 3 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/mys1024/worker-fn
- Owner: mys1024
- License: mit
- Created: 2024-02-19T06:41:10.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-05T17:23:40.000Z (6 months ago)
- Last Synced: 2024-11-02T20:34:23.125Z (12 days ago)
- Topics: frontend, function, jsr, npm, package, web, webworker
- Language: TypeScript
- Homepage:
- Size: 376 KB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# worker-fn
[](https://jsr.io/@mys/worker-fn)
[](https://www.npmjs.com/package/worker-fn)
[](https://bundlephobia.com/package/worker-fn)
[](https://jsr.io/@mys/worker-fn/doc?style=flat-square)
[](https://github.com/mys1024/worker-fn)
[](./LICENSE)
[](https://github.com/mys1024/worker-fn/actions/workflows/ci.yml)
[](https://github.com/mys1024/worker-fn/actions/workflows/release.yml)
English | [中文文档](./README_zh.md)
`worker-fn` hides the complexity of communication between the JavaScript main
thread and [Worker](https://developer.mozilla.org/docs/Web/API/Web_Workers_API)
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).
## Usage
### Basic
`math.worker.js`:
```javascript
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`:
```javascript
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)); // 5
```
### Using `defineWorkerFns()` and `useWorkerFns()`
Example
`math.worker.js`:
```javascript
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`:
```javascript
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)); // 5
```
### Using with TypeScript
Example
`math.worker.ts`:
```typescript
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`:
```typescript
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", worker);
const fib = useWorkerFn("fib", worker);
console.log(await add(1, 2)); // 3
console.log(await fib(5)); // 5
```
### Using in Node.js with `node:worker_threads`
Example
`math.worker.js`:
```javascript
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`:
```javascript
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)); // 5
```
## Importing from JSR
`worker-fn` is published on both [npm](https://www.npmjs.com/package/worker-fn)
and [JSR](https://jsr.io/@mys/worker-fn). If you want to import `worker-fn` from
JSR, please refer to
[this document](https://jsr.io/docs/introduction#using-jsr-packages).
## License
[MIT](./LICENSE) License © 2024-PRESENT
[mys1024](https://github.com/mys1024)