troika-worker-utils

What is troika-worker-utils?

The troika-worker-utils package provides utilities for managing and communicating with web workers in JavaScript. It simplifies the process of offloading tasks to background threads, allowing for more efficient and responsive applications.

What are troika-worker-utils's main functionalities?

WorkerPool

The WorkerPool feature allows you to create a pool of web workers to handle multiple tasks concurrently. This can be particularly useful for tasks that are computationally intensive and can be parallelized.

const { WorkerPool } = require('troika-worker-utils');

const pool = new WorkerPool({
  maxWorkers: 4,
  workerScriptURL: 'path/to/worker/script.js'
});

pool.postMessage({ task: 'heavyComputation', data: { /* some data */ } })
  .then(result => {
    console.log('Result from worker:', result);
  });

createWorker

The createWorker feature allows you to create a web worker from a function. This is useful for defining worker behavior inline without needing a separate worker script file.

const { createWorker } = require('troika-worker-utils');

const worker = createWorker(function() {
  self.onmessage = function(e) {
    const result = e.data * 2; // Example computation
    self.postMessage(result);
  };
});

worker.postMessage(10);
worker.onmessage = function(e) {
  console.log('Result from worker:', e.data); // Should log 20
};

Other packages similar to troika-worker-utils

workerpool

The workerpool package provides a similar functionality to troika-worker-utils by allowing you to create a pool of web workers to handle parallel tasks. It offers a flexible API for managing worker threads and handling task distribution. Compared to troika-worker-utils, workerpool has a more extensive API and additional features like dynamic worker creation and task prioritization.

comlink

Comlink is a package that simplifies the use of web workers by providing a proxy-based API for communication. It allows you to call functions in the worker as if they were local, making the worker communication more intuitive. While troika-worker-utils focuses on worker management and task distribution, Comlink emphasizes ease of use and seamless function calls between the main thread and workers.

README

troika-worker-utils

TODO: description

Usage

const troikaWorkerUtils = require('troika-worker-utils');

// TODO: DEMONSTRATE API