@deox/worker-rpc v0.0.15

@deox/worker-rpc

Lightweight RPC utility for calling functions in Web Workers and receiving results with simple, promise-based syntax.
Can be used with webpack or other bundlers.

Installation

Install the package by running the following command in terminal:

npm install @deox/worker-rpc

Usage

The module can be imported using import in ES Modules and require in Common JS as shown below:

ES Modules:

// index.ts
import { Worker } from "@deox/worker-rpc";

// ...

Common JS:

// index.cjs
const { Worker } = require("@deox/worker-rpc");

// ...

Example

Following is an example of using this library with webpack:

Create a worker.ts as shown below:

// worker.ts
import { register } from "@deox/worker-rpc/register";

export type Context = {
  info: string;
};

const registered = register((ctx: Context) => ({
  hello: () => `Hello from worker with info: ${ctx.info}`,
  sum: (...numbers: number[]) => numbers.reduce((p, c) => p + c)
}));

export type Registered = typeof registered;

Create a Worker instance in your entrypoint and utilize it:

// index.ts
import { Worker } from "@deox/worker-rpc";
import { type Context, type Registered } from "./worker";

const context: Context = {
  info: "This works!"
};

const worker = new Worker<Registered>(
  new URL("./worker", import.meta.url),
  { context, name: "my-worker" }
);

// Call the methods :)
worker.call("hello").then(result => {
  // Do something with result
  console.log(result);
});

// Or use ES6 Proxy
worker.proxy.sum(20, 50, 30).then(result => {
  // Do something with result
  console.log(result);
});

Note: It doesn't matter your registered methods are synchronous or asynchronous, the methods called using Worker instance will always return a Promise which resolves or rejects based on method logic.