Skip to content

Add bundler setup instructions #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
romot-co merged 1 commit into from
May 27, 2025
Merged

Add bundler setup instructions #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,21 @@ The encoder automatically tries these locations:
3. Package worker file (fallback, may require CORS setup)
4. Inline helper (shows setup instructions if above fail)

## Setup for Vite/PWA projects

If you're bundling your application with tools like **Vite**, **Webpack**, or **Rollup**, you can let the bundler resolve the worker file directly instead of copying it manually. Construct the worker URL using `import.meta.url`:

```ts
const workerUrl = new URL(
'./node_modules/webcodecs-encoder/dist/worker.js',
import.meta.url
).toString();

await encoder.initialize({ workerScriptUrl: workerUrl });
```

This allows your bundler to include the worker script in the build and serve it correctly without any manual steps.

## Basic Usage

### Traditional API (Constructor-based)
Expand Down