vite-plugin-wasm


Add WebAssembly ESM integration (aka. Webpack's asyncWebAssembly) to Vite and support wasm-pack generated modules.

Installation

This plugin supports from Vite 2.x to 6.x. Just install it:

``bash
yarn add -D vite-plugin-wasm
`

Usage

You also need the vite-plugin-top-level-await plugin unless you target very modern browsers only (i.e. set build.target to esnext).

`typescript
import wasm from "vite-plugin-wasm";
import topLevelAwait from "vite-plugin-top-level-await";

export default defineConfig({
plugins: [
wasm(),
topLevelAwait()
]
});
`

If you are getting ESBuild errors of WASM files (In the format No loader is configured for ".wasm" files: node_modules/somepackage/somefile.wasm) with Vite < 3.0.3, please upgrade your Vite to >= 3.0.3 or upgrade this plugin to >= 3.1.0. A workaround is adding the corresponding imported module within node_modules to optimizeDeps.exclude, e.g.:

`typescript
export default defineConfig({
optimizeDeps: {
exclude: [
"@syntect/wasm"
]
}
});
`

Web Worker

To use this plugin in Web Workers. Add it (and vite-plugin-top-level-await if necessary) to worker.plugins. To support Firefox, don't use ES workers. leave worker.format default and use vite-plugin-top-level-await >= 1.4.0 (see also here):

`ts
export default defineConfig({
plugins: [
wasm(),
topLevelAwait()
],
worker: {
// Not needed with vite-plugin-top-level-await >= 1.3.0
// format: "es",
plugins: [
wasm(),
topLevelAwait()
]
}
});
`

Notes

TypeScript typing is broken. Since we can't declare a module with Record as its named export map. Your import ... from "./module.wasm"; will still got Vite's bulit-in typing, but the transformed code is fine. So just use an asterisk import import * as wasmModule from "./module.wasm"` and type assertion (you have typing for your WASM files, right?).