@okikio/sharedworker

NPM | Github | Docs | Licence

A small mostly spec. compliant polyfill/ponyfill for SharedWorkers, it acts as a drop in replacement for normal Workers, and supports a similar API surface that matches normal Workers.

Ponyfills are seperate modules that are included to replicate the functionality of the original API, but are not required to be used.

Polyfills update the original API on the global scope if it isn't supported in that specific environment or it's feature set is lacking compared to modern variations.

Check out the blog post, created for it's launch.

Installation

npm install @okikio/sharedworker

Others

yarn add @okikio/sharedworker

or

pnpm install @okikio/sharedworker

Usage

import { SharedWorkerPolyfill as SharedWorker } from "@okikio/sharedworker";
// or 
import SharedWorker from "@okikio/sharedworker";

You can also use it directly through a script tag:

<script src="https://unpkg.com/@okikio/sharedworker"></script>
<script type="module">
    // You can then use it like this
    const { SharedWorkerPolyfill: SharedWorker } = window.sharedworker; 
</script>

You can also use it via a CDN, e.g.

import SharedWorker from "https://cdn.skypack.dev/@okikio/sharedworker";
// or 
import SharedWorker from "https://cdn.jsdelivr.net/npm/@okikio/sharedworker";
// or
import SharedWorker from "https://esm.sh/@okikio/sharedworker";
// or any number of other CDN's

For vite and other bundlers you can also use the new SharedWorkerPonyfill like so (#9), to address one-off issues with workers

import { SharedWorkerPonyfill, SharedWorkerSupported } from "@okikio/sharedworker";

let worker: SharedWorkerPonyfill;

if (SharedWorkerSupported) {
    worker = new SharedWorkerPonyfill(new SharedWorker(new URL("./../worker.ts", import.meta.url), { name: "position-sync", type: "module" }));
} else {
    worker = new SharedWorkerPonyfill(new Worker(new URL("./../worker.ts", import.meta.url), { name: "position-sync", type: "module" }));
}

@okikio/sharedworker supports the same API surfaces as SharedWorker and Worker, except it adds some none spec. compliant properties and methods to the SharedWorkerPolyfill class, that enables devs to use SharedWorker's on browsers that don't support it.

In order to support browsers that don't natively support SharedWorker's, the actual worker file needs to be tweaked slightly,

/* 
 * All variables and values outside the `start(...)` function are shared between all pages, this behavior can cause unexpected bugs if you're not careful
 */
const start = (port) => {
    // All your normal Worker and SharedWorker stuff can be placed here and should just work, with no extra setup required 
    
    /** 
     * All variables and values inside the `start(...)` function are isolated to each page, and will be allocated seperately per page. 
     */
    port.onmessage = ({ data }) => {
        console.log("Cool")
    };
};

self.onconnect = e => {
    let [port] = e.ports;
    start(port);
};

// This is the fallback for WebWorkers, in case the browser doesn't support SharedWorkers natively
if (!("SharedWorkerGlobalScope" in self)) 
    start(self);

Note: make sure to read the comments in the above code carefully to avoid unexpected bugs.

Showcase

A couple sites that use @okikio/sharedworker:

astro.build/play - GitHub
bundlejs.com - GitHub
Your site here...

API

The API of @okikio/sharedworker closely match the web SharedWorker API, except that all the major methods and properties of SharedWorker.prototype.port are available directly on SharedWorker.prototype including addEventListener and removeEventListener.

Note: the normal functionality of the methods and properties that are normally available on SharedWorker.prototype will still be kept intact, in @okikio/sharedworker.

In addition, the terminate() method was added to @okikio/sharedworker, this allows both the close() method (this is from SharedWorker.prototype.port) and the terminate() method to manually close workers.

Check out the API site for detailed API documentation.

Browser Support

Chrome	Edge	Firefox	Safari	IE
4+	12+	4+	4+	10+

Native support for SharedWorker is not supported at all on Safari and IE, as well as all mobile browsers (excluding Firefox For Android).

Note: some features of Workers appeared at later versions of the spec., so, I suggest looking into the feature support table for Workers and SharedWorkers.

Contributing

I encourage you to use pnpm to contribute to this repo, but you can also use yarn or npm if you prefer.

Install all necessary packages

npm install

Then run tests (WIP)

npm test

Build project

npm run build

Preview API Docs

npm run typedoc && npm run preview

Note: this project uses Conventional Commits standard for commits, so, please format your commits using the rules it sets out.

Licence

See the LICENSE file for license rights and limitations (MIT).