Registry / web-framework / esbuild-plugin-webworker

esbuild-plugin-webworker

library0.0.3jsnpmunverified

An ESbuild plugin for handling Web Workers by marking imports with `?worker` query suffix. v0.0.3 (sparse releases). Supports inlining worker code (default) or outputting separate files. Requires ESbuild ≥0.18.0 and Node ≥14.0.0. Differentiators: simple query-based syntax, automatic bundling and minification, TypeScript support. Limited community adoption and maintenance.

web-framework devops

npm install esbuild-plugin-webworker

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-WEB

esbuild-plugin-webworker

web-frameworkjavascriptv0.0.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

default

✓ import webworker from 'esbuild-plugin-webworker'

✗ const webworker = require('esbuild-plugin-webworker')

Plugin is ESM only, does not support CommonJS require.

createWorker

✓ import createWorker from './fib_worker?worker'

✗ import createWorker from './fib_worker'

Worker files must be imported with the `?worker` query suffix to be detected by the plugin.

type PluginOptions

✓ import type { PluginOptions } from 'esbuild-plugin-webworker'

TypeScript types are shipped with the package.

Sets up esbuild with the webworker plugin, builds a main file that imports a worker script via `?worker`, and runs Fibonacci computation in a worker.

// build.js import { build } from 'esbuild'; import webworker from 'esbuild-plugin-webworker'; build({ entryPoints: ['src/main.ts'], outfile: 'dist/bundle.js', bundle: true, plugins: [webworker()], format: 'esm', }).catch(() => process.exit(1)); // src/main.ts import createWorker from './fib.worker?worker'; const worker = createWorker(); const promise = new Promise<number>((resolve) => { worker.onmessage = (e) => resolve(e.data); }); worker.postMessage(40); console.log(await promise);

Debug

Known issues

gotchaPlugin only supports ESM; do not use require() to import the plugin or worker modules.

fix

Use import syntax in an ES module context (add 'type':'module' in package.json or use .mjs extension).

affects: >=0.0.0

deprecatedNode.js v14 is minimum but v14 is end-of-life; consider upgrading to Node v18+.

fix

Update Node to v18 or higher.

affects: >=0.0.0

breakingRequires esbuild v0.18.0+; older versions will fail with unknown plugin error.

fix

Upgrade esbuild to >=0.18.0

affects: <0.18.0

gotchaDefault inline:true may cause large bundles if worker code is substantial; memory usage can be high.

fix

Set inline:false and specify an out directory to generate separate worker files.

affects: >=0.0.0

Errors

Common errors & fixes

Error: The plugin "esbuild-plugin-webworker" is not compatible with the current version of esbuild. Required esbuild >= 0.18.0

Installed esbuild version is too low (<0.18.0).

fix

Run `npm install esbuild@latest` to update to a compatible version.

SyntaxError: Cannot use import statement outside a module

Using import syntax in a CommonJS file without enabling ESM.

fix

Set `"type": "module"` in your package.json or rename the file to .mjs.

TypeError: webworker is not a function

Default import used with CommonJS require; plugin exports ES module default.

fix

Switch to ESM import or use dynamic import: `import('esbuild-plugin-webworker').then(m => m.default())`.

Upgrade

Version history

0.0.3latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency, required v0.18.0+

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/simo-an/bundle-plugins ↗

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