docs: state the browser engine boundaries - #21
Merged
Conversation
The support matrix named only Chromium, so an agent evaluating the browser runtime for a Cordova app had no answer for WKWebView. The runtime support section now separates the three questions: which API gates persistence (OPFS sync access handles, with the Safari 16.4 and Firefox 111 arrival points), which APIs the multi-tab hosts need (Web Locks and BroadcastChannel, universally available), and why an embedded WebView must be probed even when the platform browser qualifies. Fail-fast persistent open and everywhere-working temporary storage give the probe a safe shape.
Greptile SummaryAdds browser-runtime support boundaries and deployment guidance to the support documentation.
Confidence Score: 5/5The documentation-only PR appears safe to merge. The added guidance accurately distinguishes persistent OPFS storage, temporary storage, and multi-tab browser requirements without changing runtime behavior or introducing a documented contradiction. Important Files Changed
Reviews (1): Last reviewed commit: "docs: state the browser engine boundarie..." | Re-trigger Greptile |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The support matrix said only "Chromium through Playwright", which leaves the most common adoption question unanswered: does the browser runtime work in my WebView? An agent evaluating the library for a Cordova/WKWebView app hit exactly that wall.
docs/support.mdnow answers it in three parts:BroadcastChannel, available in every current engine.sqliteWasm({ storage: "persistent" })fails fast where OPFS is missing and temporary storage works wherever the WASM module loads, so the note prescribes probing the target WebView before committing to durable in-app state.Docs-only;
check:documentationpasses.