workerize-transferable

Helper functions for workerlize-loader to support transferables.

Install

1npm i -D workerize-loader
2npm i -S @naoak/workerize-transferable

Usage

worker.js:

1import { setupTransferableMethodsOnWorker } from "@naoak/workerize-transferable";
2
3export function increment(buffer) {
4  buffer[0] += 1;
5  return buffer;
6}
7
8setupTransferableMethodsOnWorker({
9  // the name of function which use some transferables
10  increment: {
11    // specify an instance of the function
12    fn: increment,
13    // pick a transferable object from the result which is an instance of Int32Array
14    pickTransferablesFromResult: (result) => [result.buffer],
15  },
16});

index.js:

1import worker from "workerize-loader!./worker";
2import { setupTransferableMethodsOnMain } from "@naoak/workerize-transferable";
3
4let instance = worker(); // `new` is optional
5
6setupTransferableMethodsOnMain({
7  // worker instance
8  instance,
9  // the name of method which use some transferables
10  increment: {
11    // pick a transferable object from the method parameters
12    pickTransferablesFromParams: (params) => [params[0].buffer],
13  },
14});
15
16(async () => {
17  const buffer = new Int32Array([0]);
18  const res = await instance.increment(await instance.increment(buffer));
19  console.log(buffer.length); // 0
20  console.log(res.length); // 1
21  console.log(res[0]); // 2
22})();

See workerize-loader for details how to setup workerize-loader.