WorkerStore ​

The WorkerStore class is a utility that can be used to make it easier to use the workers in your project. It is not required though, and you can load the workers by themselves if you prefer.

Usage ​

import { WorkerStore } from "simple-worker-vite";
const workerStore = new WorkerStore();

workerStore
	.spawn("my-worker-name")
	.then((worker) => {
		worker.addEventListener("message", (event) => {
			// ...
		});
		worker.postMessage("Hello World!");
	});

The WorkerStore class is a singleton, so you can import and instantiate it anywhere in your project and it will always be the same instance.

spawn ​

The spawn method is used to load a worker by name. It returns a promise that resolves to the worker instance which can then be used as you would normally use a web worker.

This is where the name property used in the vite config comes into play.

workerStore.spawn("my-worker-name");

Base Path ​

The WorkerStore will automatically load the worker from the /workers/ path (by default).

You can change this by setting the argument when instantiating the WorkerStore.

const workerStore = new WorkerStore("/workers/");

or by setting the base property.

workerStore.base = "/workers/";