Evolu for Web
This package provides browser-specific Evolu implementations, including OPFS-backed SQLite, Web Workers, Shared Workers, and browser platform dependencies.
SQLite comes from @evolu/sqlite-wasm. Bundlers emit its WebAssembly binary
with the app. Vite does not emit it from a dependency it prebundles, so add
@evolu/sqlite-wasm to optimizeDeps.exclude.
As runtimes increasingly implement the same Web Platform APIs, Evolu's portable
abstractions for WebSocket, MessagePort, and Web Locks live in
@evolu/common. Their concrete implementations are supplied by the runtime.
Documentation
For detailed information and usage examples, please visit evolu.dev.
Source, examples, and tests
The npm package includes source and tests matching the installed version in
node_modules/@evolu/web/. The links below open GitHub's main
branch; use the installed files when checking version-specific behavior.
src/contains the implementation and JSDoc API documentation, including usage examples such as those inTask.ts.*.test.tsfiles alongside the source show tested behavior and edge cases. SeeTask.test.ts, for example.
For application imports, use the exports in the installed package's
package.json. Relative imports in tests may access internal helpers.
Community
The Evolu community is on GitHub Discussions, where you can ask questions and voice ideas.
To chat with other community members, you can join the Evolu Discord.
