Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dai-shi/react-hooks-worker
React custom hooks for web workers
https://github.com/dai-shi/react-hooks-worker
custom-hook react react-hooks reactjs webworker worker
Last synced: about 2 months ago
JSON representation
React custom hooks for web workers
- Host: GitHub
- URL: https://github.com/dai-shi/react-hooks-worker
- Owner: dai-shi
- License: mit
- Created: 2019-01-27T13:15:12.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T10:28:34.000Z (over 1 year ago)
- Last Synced: 2024-07-19T10:58:31.702Z (about 2 months ago)
- Topics: custom-hook, react, react-hooks, reactjs, webworker, worker
- Language: TypeScript
- Size: 2.44 MB
- Stars: 700
- Watchers: 10
- Forks: 17
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-react-hooks - `react-hooks-worker`
- awesome-react-hooks-cn - `react-hooks-worker`
- awesome-react-hooks - `react-hooks-worker`
- awesome-react-hooks - `react-hooks-worker`
README
# react-hooks-worker
[](https://github.com/dai-shi/react-hooks-worker/actions?query=workflow%3ACI)
[](https://www.npmjs.com/package/react-hooks-worker)
[](https://bundlephobia.com/result?p=react-hooks-worker)
[](https://discord.gg/MrQdmzd)
React custom hooks for web workers.
## Introduction
Web Workers are another thread from the main thread in browsers.
We can run heavy computation in a separate thread so that
users don't feel slowing down.
React provides a reactive system.
This library hides the async nature of Web Workers with React custom hooks.
Results returned by Web Workers are stored in a React local state.
Developers can implement a worker as:
* sync function
* async function
* sync generator function
* async generator function
## Install
```bash
npm install react-hooks-worker
```
## Usage
slow_fib.worker.js:
```javascript
import { exposeWorker } from 'react-hooks-worker';
const fib = i => (i <= 1 ? i : fib(i - 1) + fib(i - 2));
exposeWorker(fib);
```
app.js:
```javascript
import React from 'react';
import { useWorker } from 'react-hooks-worker';
const createWorker = () => new Worker(
new URL('./slow_fib.worker', import.meta.url),
{ type: 'module' }
);
const CalcFib = ({ count }) => {
const { result, error } = useWorker(createWorker, count);
if (error) return
Error: {error};
return Result: {result};
};
const App = () => (
);
```
## Recipes
### Pending status
The communication between main thread and worker thread is not RPC model.
It can be one input to return multiple outputs, or
multiple inputs to get one output.
Handling pending or stale status is left for library users.
Refer [#44](https://github.com/dai-shi/react-hooks-worker/issues/44)
for a recipe for `isStale`.
## API
### exposeWorker
expose worker
You can expose any function that returns:
* A value
* A promise
* An iterable
* An async iterable
#### Parameters
* `func` **function (data: any): any**
* `getOptions` **function (): WindowPostMessageOptions?**
#### Examples
```javascript
import { exposeWorker } from 'react-hooks-worker';
const fib = (i) => (i <= 1 ? i : fib(i - 1) + fib(i - 2));
exposeWorker(fib);
```
### useWorker
use worker
The createWorker function should be stable to keep the worker running.
If it's referentially changed, it will create a new worker and terminate the old one.
#### Parameters
* `createWorker` **function (): [Worker](https://developer.mozilla.org/docs/Web/JavaScript)**
* `input` **Input**
* `getOptions` **function (): WindowPostMessageOptions?**
#### Examples
```javascript
import { useWorker } from 'react-hooks-worker';
const createWorker = () => new Worker(
new URL('./slow_fib.worker', import.meta.url),
{ type: 'module' }
);
const CalcFib = ({ count }) => {
const { result, error } = useWorker(createWorker, count);
if (error) return
Error: {error};
return Result: {result};
};
```
## Examples
The [examples](examples) folder contains working examples.
You can run one of them with
```bash
PORT=8080 npm run examples:01_minimal
```
and open in your web browser.
## Blogs
* [Playing with React Hooks and Web Workers](https://blog.axlight.com/posts/playing-with-react-hooks-and-web-workers/)
* [How I Developed React Hooks for Web Workers](https://blog.axlight.com/posts/how-i-developed-react-hooks-for-web-workers/)