@farmfe/plugin-worker

A Rust Farm plugin for importing web worker scripts with new Worker(), new SharedWorker(), and worker query suffixes.

Installation

npm install -D @farmfe/plugin-worker

yarn add -D @farmfe/plugin-worker

pnpm add -D @farmfe/plugin-worker

Usage

Register the plugin in farm.config.ts:

import { defineConfig } from "@farmfe/core";
import worker from "@farmfe/plugin-worker";

export default defineConfig({
  plugins: [worker()],
});

Import via constructor

Use the standard worker constructor syntax:

const worker = new Worker(new URL("./worker.js", import.meta.url));

Module workers are supported through the constructor options:

const worker = new Worker(new URL("./worker.js", import.meta.url), {
  type: "module",
});

Import with query suffix

Use ?worker or ?sharedworker to import a custom worker constructor:

import MyWorker from "./worker?worker";

const worker = new MyWorker();

Add inline to inline the worker as a base64 string, or url to read it as a URL:

import InlineWorker from "./worker?worker&inline";
import WorkerUrl from "./worker?worker&url";

Options

• compilerConfig?: Config — optional Farm compilation config used when compiling workers.