npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-web-worker-agc

v1.0.2

Published

web worker manager for react

Downloads

19

Readme

react-web-worker-agc

A powerful and efficient Web Worker manager for React applications.

Description

react-web-worker-agc is a npm package that provides a robust solution for managing Web Workers in React applications. It offers a WorkerPool class that allows you to create, manage, and optimize the use of Web Workers, enabling better performance for CPU-intensive tasks in your React applications.

Features

  • Create and manage a pool of Web Workers
  • Automatic task queuing and distribution
  • Idle worker termination for optimized resource usage
  • Easy integration with React components through a custom hook
  • Garbage collection to clean up idle workers

Installation

Install the package using npm:

npm install react-web-worker-agc

Basic Usage



import { WorkerPool } from 'react-web-worker-agc';

// Create a WorkerPool instance
const pool = new WorkerPool(YourWorkerScript, 5, 300000);

// Start the garbage collector
pool.startGarbageCollector();

// Run a task
const result = await pool.runTask(someData);

// When done, terminate all workers
pool.terminateAll();

Using with React Custom Hook

import React, { useState, useEffect } from "react";
import { WorkerPool } from "react-web-worker-agc";

function useWorkerPool(workerFile, threadCount) {
  const [pool, setPool] = useState(null);

  useEffect(() => {
    const newPool = new WorkerPool(workerFile, threadCount, 60000);
    newPool.startGarbageCollector();
    setPool(newPool);
    return () => {
      // Clean up the worker pool when the component unmounts
      if (newPool) {
        newPool.terminateAll();
      }
    };
  }, [workerFile, threadCount]);

  return pool;
}

export default useWorkerPool;

API Reference

  • WorkerPool

Constructor

  • new WorkerPool(workerScript, maxWorkers = 3, idleTimeout = 120000)

  • workerScript: The Web Worker script to be used

  • maxWorkers: Maximum number of workers in the pool (default: 3)

  • idleTimeout: Time in milliseconds before an idle worker is terminated (default: 120000)

Methods

  • runTask(data): Submits a task to be processed by a Web Worker
  • startGarbageCollector(): Starts the garbage collector to clean up idle workers
  • stopGarbageCollector(): Stops the garbage collector
  • terminateAll(): Terminates all workers and clears the poo

Contributing

  • Contributions are welcome! Please feel free to submit a Pull Request.

License

  • This project is licensed under the ISC License.

Support

  • If you encounter any problems or have any questions, please open an issue on the GitHub repository.

Author

Gautam Jain