Registry / devops / esbuild-plugin-inline-worker

esbuild-plugin-inline-worker

library0.1.1jsnpmunverified

An esbuild plugin that inlines Web Worker code directly into the bundle, eliminating the need for a separate worker file. Version 0.1.1 is stable, with no recent updates. It supports importing .worker.js/.ts/.jsx/.tsx files to get a Worker constructor, bundling the worker code with a separate esbuild build. Unlike worker-loader for webpack, this plugin fully inlines the worker, making it ideal for libraries where worker file management is cumbersome. It ships TypeScript definitions and allows custom esbuild configuration for the worker build.

devops

npm install esbuild-plugin-inline-worker

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-INL

esbuild-plugin-inline-worker

devopsjavascriptv0.1.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

inlineWorkerPlugin

✓ import inlineWorkerPlugin from 'esbuild-plugin-inline-worker'

✗ const inlineWorkerPlugin = require('esbuild-plugin-inline-worker')

ESM-only. No default export in CommonJS; must use dynamic import or build tool that handles ESM.

Worker (from .worker.js import)

✓ import Worker from './example.worker.js'

✗ const { Worker } = require('./example.worker.js')

Worker is a default export from the .worker file, treated as a class constructor.

extraConfig (plugin options)

✓ inlineWorkerPlugin({ format: 'iife' })

✗ inlineWorkerPlugin({ extraConfig: { format: 'iife' } })

The argument is directly the esbuild build options object; not nested under extraConfig.

Shows how to use the plugin in an esbuild build and import a .worker.ts file to create an inlined Web Worker.

import { build } from 'esbuild'; import inlineWorkerPlugin from 'esbuild-plugin-inline-worker'; await build({ entryPoints: ['src/index.ts'], bundle: true, outfile: 'dist/bundle.js', plugins: [inlineWorkerPlugin()], }); // src/index.ts import Worker from './worker.worker.ts'; const worker = Worker(); worker.onmessage = (e) => { console.log(e.data); }; worker.postMessage('hello');

Debug

Known issues

gotchaWorker files must use the .worker.js/.worker.ts (etc.) suffix; regular .js files will not be treated as workers.

fix

Rename worker files to include '.worker' before the extension, e.g., 'myWorker.worker.js'.

affects: >=0.1.0

gotchaThe worker code is bundled in a separate esbuild build, so global variables defined in main bundle are not available in worker unless explicitly passed.

fix

Use postMessage to pass data to the worker; avoid relying on closures.

affects: >=0.1.0

breakingESM-only: CommonJS require() will not work for this plugin. Users on older Node.js or CJS projects may encounter errors.

fix

Use dynamic import() or switch to ESM for the consuming project.

affects: >=0.1.0

deprecatedThe plugin's configuration object cannot override entryPoints, outfile, or outdir; those are deleted internally.

fix

Do not include these properties in the config passed to inlineWorkerPlugin().

affects: >=0.1.0

Errors

Common errors & fixes

Error: The plugin 'inline-worker' must have a `setup` function.

Incorrect import: the default export is a function, not an object with a setup property.

fix

Ensure you are importing the default export: import inlineWorkerPlugin from 'esbuild-plugin-inline-worker'

Cannot find module './example.worker.js' or its corresponding type declarations.

TypeScript does not recognize .worker.js files without a type declaration.

fix

Add a global declaration file: declare module '*.worker.js' { const Worker: new () => Worker; export default Worker; }

TypeError: Worker is not a constructor

Attempting to import the worker file without bundling with esbuild; the plugin must be active.

fix

Run esbuild with the inlineWorkerPlugin() included in plugins array.

Upgrade

Version history

0.1.1latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency; plugin hooks into esbuild's build process

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/mitschabaude/esbuild-plugin-inline-worker ↗

packagehttps://www.npmjs.com/package/esbuild-plugin-inline-worker ↗