Miss any of our Open RFC calls?Watch the recordings here! »

mole-rpc-transport-webworker

1.0.2 • Public • Published

Webworker Transport for Mole RPC (JSON RPC Library)

npm version Build Status Known Vulnerabilities

Offload intensive calculations to WebWorker with just several lines of code.

Mole-RPC is a tiny transport agnostic JSON-RPC 2.0 client and server which can work both in NodeJs, Browser, Electron etc.

This is WebWorker based transport but there are many more transports.

What is the reason of using JSON-RPC for WebWorkers?

People usually send data to WebWorker in a form like {id, method, params} in JSON format via postMessage. As a result they expect {id, result}. And this is what JSON RPC is. id is required when you send several request and need to map results and requests.

So, why to write own solution every time? This transport allows you use JSON RPC for calling methods in WebWorkers. Moreover, it will handle all of edge-cases like errors processing, timeouts, batch calls, bidirectional communication etc.

Mole-RPC has zero dependencies and is a very small library.

Usage example (with simplified API)

worker.js

import expose from 'mole-rpc-transport-webworker/expose';
 
const sum = (a, b) => a + b;
const multiply = (a, b) => a * b;
 
expose({ sum, multiply }).catch(console.error);
 

index.js

import createClient from 'mole-rpc-transport-webworker/createClient';
 
async function main() {
  const client = createClient(new Worker('worker.js'));
  const result = await client.sum(2, 3);
}
 
main().then(console.log, console.error);

You can pass extra Mole-RPC options to createClient as second parameter.

For example

const client = createClient(new Worker('worker.js'), { 
  requestTimeout: 1000 
});

More examples

Simple API for sending work to your web worker (recommended).

See examples/simple-send-work-to-webworker

Standard API for sending work to your web worker.

See examples/send-work-to-webworker

Bidirectional connection

Each side works as client and server the same time.

See examples/bidirectional-calls

Install

npm i mole-rpc-transport-webworker

DownloadsWeekly Downloads

1

Version

1.0.2

License

MIT

Unpacked Size

1.12 MB

Total Files

33

Last publish

Collaborators

  • avatar