This package has been deprecated

Author message:

WARNING: This project has been renamed to @webos/process. Install using @webos/process instead.

Process-js

Synopsys

Creation of Dynamic Dedicated WebWorkers, definition of dependencies, promise support.

Motivation

Today we have an opportunity to run a js code in other threads in browsers by using web workers. Web workers give us new flexibility and opportunity for creating more complex js applications. But web workers' api may create complications in some cases: for example, when we want to run the following code:

console.log('Hello world');

in other thread, we can do this in two ways:

1. Create a new file myWorker.js which will contain the code

console.log('Hello World');

and then call it from the main thread by writing

const myWorker = new Worker('./myWorker.js');

1. Or if we want to create it in a dynamic way, we can write:

const source = 'console.log("Hello world")';
 
const blob = new Blob([source], {type: 'application/javascript'});
 
const myWorker = new Worker(URL.createObjectURL(blob));

process-js lets us create dynamic workers in main thread, use and manage them more comfortably and with promise support. There is no need to create a new file, also there is no need in onmessage or onerror callbacks, the latest will work with promise support. For example:

import Process from 'process-js';
 
const process = new Process;
 
process
  .setSource(
    num => num ** 2
  )
  .postMessage(12)
  .then(
    result => console.log('Log ::: Result ::: ', result)
  );

process-js also allows to define dependencies for workers

import Process from 'process-js';
 
const process = new Process;
 
process
  .setSource(
    arr => _.sortBy(arr),
    ['https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.4/lodash.min.js']
  )
  .postMessage([3, 2, 0, 1])
  .then(
    result => console.log('Log ::: Result ::: ', result)
  );

Install

Install for usage

Latest packaged version :::

npm i process-js

or

yarn add process-js

Latest version available in GitHub :::

npm i https://github.com/webosorg/Process

or

yarn add https://github.com/webosorg/Process

Install for development

git clone https://github.com/webosorg/Process.git

Usage

NOTE ::: In this stage it's only for browsers.

Simple usage

// Import process-js
import Process from 'process-js';
 
// Create a new process
 
const process = new Process;
 
process
  // set source (fn and deps)
  .setSource(
    num => num ** 2
  )
  // send data for calculation
  .postMessage(12)
  // get result
  .then(
    result => console.log('Log ::: Result ::: ', result)
  );

With dependencies

// Import process-js
import Process from 'process-js';
 
// Create a new process
const process = new Process;
 
process
  // set source (fn and deps)
  .setSource(
    // fn
    arr => _.sortBy(arr),
    // array of dependencies
    ['https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.4/lodash.min.js']
  )
  // send data for calculation
  .postMessage([3, 2, 0, 1])
  // get result
  .then(
    result => console.log('Log ::: Result ::: ', result)
  );

Full Promise support

const process_01 = new Process;
 
const process_02 = new Process;
 
const calc_01 = process_01.setSource(arr => arr.sort(arr));
 
const calc_02 = process_01.setSource(num => num ** 2);
 
const calc_03 = process_02.setSource(
  arr => _.sortBy(arr),
  ['https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.4/lodash.min.js']
);
 
Promise.all(
  [
    calc_01.postMessage([3, 1, 2]),
    calc_02.postMessage(12),
    calc_03.postMessage(['x', 'y', 'z', 'a', 123])
  ]
)
.then(result => {
  process_01.kill();
  process_02.kill();
  console.log('Log ::: Result ::: ', result);
});

License

MIT