Skip to content
Consistent Web Workers in browser and Node.
Branch: master
Clone or download

Latest commit

Latest commit 4a46d3a May 3, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows run CI on pull requests May 3, 2020
test import-meta-url relative handling Apr 14, 2020
.gitignore working tests and implementation Dec 24, 2019 release prep Apr 10, 2020
LICENSE release prep Apr 10, 2020 Update May 3, 2020
browser.js release prep Apr 10, 2020
index.d.ts feat: type for module Apr 25, 2020
node.js Update node.js Apr 17, 2020
package.json feat: type for module Apr 25, 2020

web-worker npm

Native cross-platform Web Workers. Works in published npm modules.

In Node, it's a web-compatible Worker implementation atop Node's worker_threads.

In the browser (and when bundled for the browser), it's simply an alias of Worker.


Here's how this is different from worker_threads:

  • makes Worker code compatible across browser and Node
  • supports Module Workers ({type:'module'}) natively in Node 12.8+
  • uses DOM-style events (, Event.type, etc)
  • supports event handler properties (worker.onmessage=..)
  • Worker() accepts a module URL, Blob URL or Data URL
  • emulates browser-style WorkerGlobalScope within the worker

Usage Example

In its simplest form:

import Worker from 'web-worker';

const worker = new Worker('data:,postMessage("hello")');
worker.onmessage = e => console.log(;  // "hello"
import Worker from 'web-worker';

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

worker.addEventListener('message', e => {
  console.log(  // "hiya!"

addEventListener('message', e => {
  if ( === 'hello') {

👉 Notice how new URL('./worker.js', import.meta.url) is used above to load the worker relative to the current module instead of the application base URL. Without this, Worker URLs are relative to a document's URL, which in Node.js is interpreted to be process.cwd().

Support for this pattern in build tools and test frameworks is still limited. We are working on growing this.

Module Workers

Module Workers are supported in Node 12.8+ using this plugin, leveraging Node's native ES Modules support. In the browser, they can be used natively in Chrome 80+, or in all browsers via worker-plugin or rollup-plugin-off-main-thread. As with classic workers, there is no difference in usage between Node and the browser:

import Worker from 'web-worker';

const worker = new Worker(
  new URL('./worker.mjs', import.meta.url),
  { type: 'module' }
worker.addEventListener('message', e => {
  console.log(  // "200 OK"
import fetch from 'isomorphic-fetch';

addEventListener('message', async e => {
  const url =;
  const res = await fetch(url)
  const text = await res.text();

Data URLs

Instantiating Worker using a Data URL is supported in both module and classic workers:

import Worker from 'web-worker';

const worker = new Worker(`data:application/javascript,postMessage(42)`);
worker.addEventListener('message', e => {
  console.log(  // 42

Special Thanks

This module aims to provide a simple and forgettable piece of infrastructure, and as such it needed an obvious and descriptive name. @calvinmetcalf, who you may recognize as the author of Lie and other fine modules, gratiously offered up the name from his web-worker package. Thanks Calvin!

You can’t perform that action at this time.