kanitsharma / workinator

Run your CPU intensive functions in a separate thread on the fly

Workinator

Run your CPU intensive functions in a separate thread on the fly, and keep your application running at 60FPS.

• Works on both Browser or Nodejs
• Minimal API
• Tiny package, ~1KB gzipped
• Supports both synchronous or asynchronous code.
• Automatically cleans up memory after worker thread is finished executing.

Getting Started

  yarn add @kimera/workinator
  // or
  npm i @kimera/workinator

How it works

Basic

import workinator from '@kimera/workinator';

workinator(() => {
  console.log('Hello from worker');
})

// Thats it!.

Synchronous

import workinator from '@kimera/workinator';

const work = () => {
  // blocking thread for 2 secs
  const start = new Date().getTime();
  while (new Date().getTime() < start + 2000) {}

  return 'Work finished';
};

const main = async () => {
  const status = await workinator(work);
  console.log(status);
};

main();

Async with promises

import workinator from '@kimera/workinator';

workinator(
  () =>
    new Promise(resolve => {
      setTimeout(() => {
        resolve('Work Finished');
      }, 2000);
    }),
).then(console.log);

// or

const sleep = ms => new Promise(resolve => setTimeout(resolve, ms));

workinator(async () => {
  await sleep(2000);
  return 'Work Finished';
}).then(console.log);

Using Dependencies

Worker functions inside workerinator does not allow using closures, since its executed inside a different thread. So, instead what we can do is inject these dependencies as the second argument of workerinator and you will receive the dependencies as arguments inside worker function in their respective order.

Example

import workinator from '@kimera/workinator';

const log = x => console.log(x);

workinator(
  logger =>
    new Promise(resolve => {
      logger('Dependency working');
    }),
  log,
)