Skip to content

docs: state the browser engine boundaries #21

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
cardmagic merged 1 commit into from
Aug 23, 2026
Merged

docs: state the browser engine boundaries #21

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 docs/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ The package is ESM-only. PostgreSQL, MySQL, Redis, and SQLite WASM require
their optional peer dependency. The Node SQLite adapter has no driver
dependency beyond Node.js.

The browser runtime is tested in Chromium. The APIs it needs are standard,
so other engines work where those APIs exist; verify them on the exact
engine you target:

- Persistent storage needs OPFS sync access handles in a dedicated worker.
Chromium has them; Safari added them in 16.4; Firefox added them in 111.
- The multi-tab hosts need the Web Locks API and `BroadcastChannel`, which
every current engine provides.
- An embedded WebView is not the platform browser. Cordova and other
WKWebView or Android WebView shells can lack OPFS even when the device's
browser has it. `sqliteWasm({ storage: "persistent" })` fails fast where
OPFS is missing, and temporary storage still works wherever the WASM
module loads, so probe the target WebView before you commit to durable
in-app state.

The browser runtime needs two platform capabilities:

- Persistent storage uses the OPFS SAH pool VFS, which needs a secure context
Expand Down