Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathe42/vite-plugin-comlink
Use WebWorkers in Vite with comlink!
https://github.com/mathe42/vite-plugin-comlink
comlink vite vite-plugin vitejs webworker
Last synced: 6 days ago
JSON representation
Use WebWorkers in Vite with comlink!
- Host: GitHub
- URL: https://github.com/mathe42/vite-plugin-comlink
- Owner: mathe42
- License: mit
- Created: 2021-08-24T08:15:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T16:02:47.000Z (3 months ago)
- Last Synced: 2024-10-29T17:14:43.468Z (3 months ago)
- Topics: comlink, vite, vite-plugin, vitejs, webworker
- Language: TypeScript
- Homepage:
- Size: 278 KB
- Stars: 173
- Watchers: 4
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-vite - vite-plugin-comlink - Use WebWorkers with the power of [Comlink](https://github.com/GoogleChromeLabs/comlink) to make them enjoyable. (Plugins / Framework-agnostic Plugins)
- fucking-awesome-vite - vite-plugin-comlink - Use WebWorkers with the power of <b><code> 11619⭐</code></b> <b><code> 397🍴</code></b> [Comlink](https://github.com/GoogleChromeLabs/comlink)) to make them enjoyable. (Plugins / Framework-agnostic Plugins)
README
# vite-plugin-comlink
> This plugins requires vite >=2.8 for WebWorkers and vite >= 2.9.6 for shared worker to work properly.
Use WebWorkers with comlink.
This plugin removes the need to call `expose`, `wrap` from comlink and also you don't need to create the worker on your own.
## Upgrade Vite 4 to Vite 5
Make sure that you change the worker plugin config to a function for example like this
```ts
// vite.config.js
export default {
worker: {
plugins: () => [comlink()],
},
};
```
see https://github.com/vitejs/vite/pull/14685 for details.
## Install
```sh
npm i --save-dev vite-plugin-comlink # yarn add -D vite-plugin-comlink
npm i --save comlink # yarn add comlink
```
### Comlink install
As you don't want to wait for a new release for this plugin when a new version of comlink is released, this plugin has comlink as a peer dependency so you can install the version of comlink that you need.
### Add it to vite.config.js
```ts
// vite.config.js
import { comlink } from "vite-plugin-comlink";
export default {
plugins: [comlink()],
worker: {
plugins: () => [comlink()],
},
};
```
### Plugin order
Put this plugin as one of the first plugins. Only other plugins that create `ComlinkWorker` or `ComlinkSharedWorker` or transform files based on the existence of `ComlinkWorker` or `ComlinkSharedWorker` should come before this plugin!
## Usage
```ts
// worker.js
export const add = (a: number, b: number) => a + b;
// main.ts
// Create Worker
const instance = new ComlinkWorker(new URL("./worker.js", import.meta.url), {
/* normal Worker options*/
});
const result = await instance.add(2, 3);
result === 5;
// Create SharedWorker
const instance = new ComlinkSharedWorker(
new URL("./worker.js", import.meta.url),
{
/* normal Worker options*/
}
);
const result = await instance.add(2, 3);
result === 5;
```
### With TypeScript
Add
```ts
///
```
to your vite-env.d.ts file to make sure typescript will use `vite-plugin-comlink/client`.
```ts
// worker.ts
export const add = (a: number, b: number) => a + b;
// main.ts
// Create Worker
const instance = new ComlinkWorker(
new URL("./worker", import.meta.url),
{
/* normal Worker options*/
}
);
const result = await instance.add(2, 3);
result === 5;
// Create SharedWorker
const instance = new ComlinkSharedWorker(
new URL("./worker", import.meta.url),
{
/* normal Worker options*/
}
);
const result = await instance.add(2, 3);
result === 5;
```
### Get Worker Instance
You can get to the worker instance like this:
```ts
import { endpointSymbol } from "vite-plugin-comlink/symbol";
const api = new ComlinkWorker(
new URL("./worker", import.meta.url),
{
/* normal Worker options*/
}
);
const worker = api[endpointSymbol];
```
## Module Worker
Not all Browsers support module Workers (see https://caniuse.com/mdn-api_worker_worker_ecmascript_modules).
This results in some drawbacks for fastest and best support:
For fast development we use module Workers as bundling the complete worker on the fly is not performant.
In default settings we bundle the whole worker at build to a single file. Therefore all browsers that support Workers, work in production.
This is the same behavior as vite and it is NOT CHANGEABLE!
If you want a worker to be a module worker in production, add `type: 'module'` to the worker constructor options.
### What this means:
1. In development you need a browser that supports module Worker (see https://caniuse.com/mdn-api_worker_worker_ecmascript_modules)
2. In production all browsers are supported
## Breaking changes
### v2 to v3
- remove of customConfigs breaking FF support in development for some projects and removing the abbility for inline worker. This is a limitation of vite so if vite adds support of it this plugin will follow
- remove of typefile. For typescript support please write your own type file or switch to the new syntax.
- remove of ServiceWorker support. This was considered unstable an it was hacky so it got removed. If vite adds support for building ServiceWorker this will be added!
- you have to add comlink to `worker.plugins` array.
### v3 to v4
- the import syntax will be removed you have to switch to the new syntax!
- Removal of Warnings of leagacy (v2) options
- ESM support
- Better Source Maps
### v4 to v5
- some undocumented internal options got removed.
- full rewrite of the core transformer to fix a lot of bugs
- should be breaking free but as this is a big rewrite there might be breaking changes
## Resources
https://github.com/GoogleChromeLabs/comlink
https://github.com/surma/rollup-plugin-comlink