async-worker-state's Introduction

Async Worker

An easy way to send async messages to a web-worker.

Pros

This converts the Service-Worker / Worker's method postMessage to an async blocking call. The best part is there is no overhead on CPU or memory usage.

Installation

Install in your nodejs package and start using right away. you could provide a custom worker or follow the worker boilerplate used by us.

let state = {};

addEventListener('message', ({ data }) => {
  const {
    topic,
    message: {
      key,
      value
    }
  } = data;

  switch (topic) {
    case 'set':
      state[key] = value;
      postMessage({
        topic: 'key-set',
        message: key
      });
      break;
    case 'get':
      postMessage({
        topic: 'get-key',
        message: {
          key,
          value: state[key]
        }
      });
    default:
      break;
  }
});

A sample usage of this Async Worker as follows:

const {
  AsyncWorkerStateMessage:
} = require('async-worker');

// You could pass a custom worker path in here.
// const awInstance = aw(<YOUR_WORKER's_PATH>);
const awInstance = new aw();

// this is an anonymous function or IIFE that will set a key and retreive it to the worker's state using a key-value pair.
(async () => {
    const stored = await awInstance.setState('test',456);
    const retreived = await awInstance.getState('test');
    console.log(retreived); // This will log 456
})();

The following methods are available from the class.

// get a stored key
const getProp(key: string): any;

// set a value for a prop
const setProp(key: string, value: any): any;

// get the entire stored state
const getState(): Object;

Support

We have not released an ES6 module yet. We could use your support to release packages for ES6 Browser modules, Angular, React and definitions with better documentation.

Our IBAN is PK56 HABB 0050237000223103. Bank: HBL Pakistan. Title: Syed Ahmed Haider

Recommend Projects