⚛️useWorker() React Hook: Running heavy task in background, without blocking the UI

Use web workers with react hook

:art: Features

• Run expensive function without blocking UI ( Show live gif )
• Supports Promises pattern instead of event-messages
• Size: < 1KB , with zero dependencies
• Clear API using hook

:floppy_disk: Install

npm install --save @koale/useworker

:hammer: Import

import { useWorker, WORKER_STATUS } from "@koale/useworker";

:orange_book: Documents

• Getting Started
• APIs
• Examples
• Limitations

:bread: Demo

• Sorting : Sorting 50000 random numbers
• Csv : Generate Csv, Parse Csv, Convert to JSON
• External Dependencies Use external scripts inside WebWorkers

⚙ Web Workers

Before you start using this hook , I suggest you to read the Web Worker documentation.

:feet: Usage

import React from "react";
import { useWorker } from "@koale/useworker";

const numbers = [...Array(5000000)].map(e => ~~(Math.random() * 1000000));
const sortNumbers = nums => nums.sort();

const Example = () => {
  const [sortWorker] = useWorker(sortNumbers);

  const runSort = async () => {
    const result = await sortWorker(numbers); // non-blocking UI
    console.log("End.");
  };

  return (
    <button type="button" onClick={runSort}>
      Run Sort
    </button>
  );
};

:feet: Examples

More examples: https://github.com/alewin/useWorker/tree/develop/example

:wrench: Roadmap

• import and use external script inside useWorker function
• import and use local script inside useWorker function
• run multiple instance of the worker

:earth_asia: Contribute? Bug? New Feature?

The library is experimental so if you find a bug or would like to request a new feature , open an issue

:bulb: Similar Project

• react-hooks-worker

:scroll: License

MIT © alewin