@pyric/cli 0.1.0-alpha.20 → 0.1.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +64 -89
- package/dist/assurance/.generated/conformance-verdicts.d.ts +68 -1
- package/dist/assurance/.generated/conformance-verdicts.d.ts.map +1 -1
- package/dist/assurance/.generated/conformance-verdicts.js +68 -1
- package/dist/assurance/.generated/conformance-verdicts.js.map +1 -1
- package/dist/bridge/client/dispatch.d.ts +25 -19
- package/dist/bridge/client/dispatch.d.ts.map +1 -1
- package/dist/bridge/client/dispatch.js +41 -48
- package/dist/bridge/client/dispatch.js.map +1 -1
- package/dist/bridge/client/tool-family-factories.d.ts +26 -0
- package/dist/bridge/client/tool-family-factories.d.ts.map +1 -0
- package/dist/bridge/client/tool-family-factories.js +10 -0
- package/dist/bridge/client/tool-family-factories.js.map +1 -0
- package/dist/bridge/server/mcp-contract.d.ts +7 -6
- package/dist/bridge/server/mcp-contract.d.ts.map +1 -1
- package/dist/bridge/server/mcp-contract.js +9 -48
- package/dist/bridge/server/mcp-contract.js.map +1 -1
- package/dist/bridge/server/peer.d.ts +11 -1
- package/dist/bridge/server/peer.d.ts.map +1 -1
- package/dist/bridge/server/peer.js +22 -1
- package/dist/bridge/server/peer.js.map +1 -1
- package/dist/bridge/server/tool-family-factories.d.ts +30 -0
- package/dist/bridge/server/tool-family-factories.d.ts.map +1 -0
- package/dist/bridge/server/tool-family-factories.js +22 -0
- package/dist/bridge/server/tool-family-factories.js.map +1 -0
- package/dist/bridge/server/tool-metadata.d.ts +17 -18
- package/dist/bridge/server/tool-metadata.d.ts.map +1 -1
- package/dist/bridge/server/tool-metadata.js +24 -59
- package/dist/bridge/server/tool-metadata.js.map +1 -1
- package/dist/bridge/tool-families.d.ts +48 -0
- package/dist/bridge/tool-families.d.ts.map +1 -0
- package/dist/bridge/tool-families.generated.d.ts +32 -0
- package/dist/bridge/tool-families.generated.d.ts.map +1 -0
- package/dist/bridge/tool-families.generated.js +15 -0
- package/dist/bridge/tool-families.generated.js.map +1 -0
- package/dist/bridge/tool-families.js +51 -0
- package/dist/bridge/tool-families.js.map +1 -0
- package/dist/bridge/tool-family-records/conformance.d.ts +7 -0
- package/dist/bridge/tool-family-records/conformance.d.ts.map +1 -0
- package/dist/bridge/tool-family-records/conformance.js +6 -0
- package/dist/bridge/tool-family-records/conformance.js.map +1 -0
- package/dist/bridge/tool-family-records/firestore-data.d.ts +7 -0
- package/dist/bridge/tool-family-records/firestore-data.d.ts.map +1 -0
- package/dist/bridge/tool-family-records/firestore-data.js +15 -0
- package/dist/bridge/tool-family-records/firestore-data.js.map +1 -0
- package/dist/bridge/tool-family-records/firestore-inspect.d.ts +7 -0
- package/dist/bridge/tool-family-records/firestore-inspect.d.ts.map +1 -0
- package/dist/bridge/tool-family-records/firestore-inspect.js +6 -0
- package/dist/bridge/tool-family-records/firestore-inspect.js.map +1 -0
- package/dist/bridge/tool-family-records/firestore-rules.d.ts +7 -0
- package/dist/bridge/tool-family-records/firestore-rules.d.ts.map +1 -0
- package/dist/bridge/tool-family-records/firestore-rules.js +15 -0
- package/dist/bridge/tool-family-records/firestore-rules.js.map +1 -0
- package/dist/bridge/tool-family-records/firestore-simulator.d.ts +7 -0
- package/dist/bridge/tool-family-records/firestore-simulator.d.ts.map +1 -0
- package/dist/bridge/tool-family-records/firestore-simulator.js +16 -0
- package/dist/bridge/tool-family-records/firestore-simulator.js.map +1 -0
- package/dist/bridge/tool-family-records/rtdb-inspection.d.ts +7 -0
- package/dist/bridge/tool-family-records/rtdb-inspection.d.ts.map +1 -0
- package/dist/bridge/tool-family-records/rtdb-inspection.js +6 -0
- package/dist/bridge/tool-family-records/rtdb-inspection.js.map +1 -0
- package/dist/bundler/externals.d.ts +37 -0
- package/dist/bundler/externals.d.ts.map +1 -0
- package/dist/bundler/externals.js +52 -0
- package/dist/bundler/externals.js.map +1 -0
- package/dist/bundler/index.d.ts +17 -0
- package/dist/bundler/index.d.ts.map +1 -0
- package/dist/bundler/index.js +17 -0
- package/dist/bundler/index.js.map +1 -0
- package/dist/cli/inlined-sdk-scanner.d.ts +6 -0
- package/dist/cli/inlined-sdk-scanner.d.ts.map +1 -0
- package/dist/cli/inlined-sdk-scanner.js +82 -0
- package/dist/cli/inlined-sdk-scanner.js.map +1 -0
- package/dist/cli/sandbox-interlock.d.ts +97 -0
- package/dist/cli/sandbox-interlock.d.ts.map +1 -0
- package/dist/cli/sandbox-interlock.js +112 -0
- package/dist/cli/sandbox-interlock.js.map +1 -0
- package/dist/cli/sandbox-runner.d.ts +20 -12
- package/dist/cli/sandbox-runner.d.ts.map +1 -1
- package/dist/cli/sandbox-runner.js +24 -21
- package/dist/cli/sandbox-runner.js.map +1 -1
- package/dist/cli/serve.d.ts +6 -10
- package/dist/cli/serve.d.ts.map +1 -1
- package/dist/cli/serve.js +57 -77
- package/dist/cli/serve.js.map +1 -1
- package/dist/cli/unsupported-runtime.d.ts +27 -0
- package/dist/cli/unsupported-runtime.d.ts.map +1 -0
- package/dist/cli/unsupported-runtime.js +63 -0
- package/dist/cli/unsupported-runtime.js.map +1 -0
- package/dist/conformance/.generated/can-i-use-browser.d.ts +1 -1
- package/dist/conformance/.generated/can-i-use-browser.d.ts.map +1 -1
- package/dist/conformance/.generated/can-i-use-browser.js +1 -1
- package/dist/conformance/.generated/can-i-use-browser.js.map +1 -1
- package/dist/conformance/.generated/can-i-use.d.ts +1 -1
- package/dist/conformance/.generated/can-i-use.d.ts.map +1 -1
- package/dist/conformance/.generated/can-i-use.js +1 -1
- package/dist/conformance/.generated/can-i-use.js.map +1 -1
- package/dist/conformance/.generated/conformance-docs.d.ts.map +1 -1
- package/dist/conformance/.generated/conformance-docs.js +1 -1
- package/dist/conformance/.generated/conformance-docs.js.map +1 -1
- package/dist/functions-rtdb/child.d.ts +37 -0
- package/dist/functions-rtdb/child.d.ts.map +1 -1
- package/dist/functions-rtdb/child.js +90 -21
- package/dist/functions-rtdb/child.js.map +1 -1
- package/dist/functions-rtdb/development-runtime.d.ts +3 -0
- package/dist/functions-rtdb/development-runtime.d.ts.map +1 -1
- package/dist/functions-rtdb/development-runtime.js +1 -0
- package/dist/functions-rtdb/development-runtime.js.map +1 -1
- package/dist/google-endpoints.d.ts +67 -0
- package/dist/google-endpoints.d.ts.map +1 -0
- package/dist/google-endpoints.js +119 -0
- package/dist/google-endpoints.js.map +1 -0
- package/dist/next/runtime-env.d.ts.map +1 -1
- package/dist/next/runtime-env.js +5 -0
- package/dist/next/runtime-env.js.map +1 -1
- package/dist/next/with-pyric.d.ts +1 -1
- package/dist/next/with-pyric.js +1 -1
- package/dist/register/beacon.d.ts +69 -0
- package/dist/register/beacon.d.ts.map +1 -0
- package/dist/register/beacon.js +199 -0
- package/dist/register/beacon.js.map +1 -0
- package/dist/register/index.d.ts.map +1 -1
- package/dist/register/index.js +65 -6
- package/dist/register/index.js.map +1 -1
- package/dist/register/net-guard.d.ts +110 -0
- package/dist/register/net-guard.d.ts.map +1 -0
- package/dist/register/net-guard.js +462 -0
- package/dist/register/net-guard.js.map +1 -0
- package/dist/serve/ai-diagnostics-relay.d.ts +63 -0
- package/dist/serve/ai-diagnostics-relay.d.ts.map +1 -0
- package/dist/serve/ai-diagnostics-relay.js +125 -0
- package/dist/serve/ai-diagnostics-relay.js.map +1 -0
- package/dist/serve/ai-proxy.d.ts +92 -0
- package/dist/serve/ai-proxy.d.ts.map +1 -0
- package/dist/serve/ai-proxy.js +269 -0
- package/dist/serve/ai-proxy.js.map +1 -0
- package/dist/serve/ai-status.d.ts +44 -0
- package/dist/serve/ai-status.d.ts.map +1 -0
- package/dist/serve/ai-status.js +77 -0
- package/dist/serve/ai-status.js.map +1 -0
- package/dist/serve/ai-terminal-blocks.d.ts +97 -0
- package/dist/serve/ai-terminal-blocks.d.ts.map +1 -0
- package/dist/serve/ai-terminal-blocks.js +128 -0
- package/dist/serve/ai-terminal-blocks.js.map +1 -0
- package/dist/serve/ai-terminal-text.d.ts +36 -0
- package/dist/serve/ai-terminal-text.d.ts.map +1 -0
- package/dist/serve/ai-terminal-text.js +48 -0
- package/dist/serve/ai-terminal-text.js.map +1 -0
- package/dist/serve/beacon-route.d.ts +53 -0
- package/dist/serve/beacon-route.d.ts.map +1 -0
- package/dist/serve/beacon-route.js +101 -0
- package/dist/serve/beacon-route.js.map +1 -0
- package/dist/serve/entries/active-auth-registry.d.ts +16 -0
- package/dist/serve/entries/active-auth-registry.d.ts.map +1 -0
- package/dist/serve/entries/active-auth-registry.js +48 -0
- package/dist/serve/entries/active-auth-registry.js.map +1 -0
- package/dist/serve/entries/active-auth.d.ts +18 -0
- package/dist/serve/entries/active-auth.d.ts.map +1 -0
- package/dist/serve/entries/active-auth.js +84 -0
- package/dist/serve/entries/active-auth.js.map +1 -0
- package/dist/serve/entries/auth-helper-core.d.ts +1 -0
- package/dist/serve/entries/auth-helper-core.d.ts.map +1 -1
- package/dist/serve/entries/auth-helper-core.js +4 -0
- package/dist/serve/entries/auth-helper-core.js.map +1 -1
- package/dist/serve/entries/auth-helper-dom.d.ts.map +1 -1
- package/dist/serve/entries/auth-helper-dom.js +28 -2
- package/dist/serve/entries/auth-helper-dom.js.map +1 -1
- package/dist/serve/entries/auth.d.ts.map +1 -1
- package/dist/serve/entries/auth.js +8 -0
- package/dist/serve/entries/auth.js.map +1 -1
- package/dist/serve/entries/bridge-url.d.ts +1 -1
- package/dist/serve/entries/bridge-url.js +1 -1
- package/dist/serve/entries/init.d.ts.map +1 -1
- package/dist/serve/entries/init.js +70 -4
- package/dist/serve/entries/init.js.map +1 -1
- package/dist/serve/entries/runtime.d.ts.map +1 -1
- package/dist/serve/entries/runtime.js +9 -0
- package/dist/serve/entries/runtime.js.map +1 -1
- package/dist/serve/namespace.d.ts +14 -5
- package/dist/serve/namespace.d.ts.map +1 -1
- package/dist/serve/namespace.js +57 -124
- package/dist/serve/namespace.js.map +1 -1
- package/dist/serve/runtime/chip-config.d.ts.map +1 -1
- package/dist/serve/runtime/chip-config.js +16 -2
- package/dist/serve/runtime/chip-config.js.map +1 -1
- package/dist/serve/runtime/chip-dialog.d.ts +18 -0
- package/dist/serve/runtime/chip-dialog.d.ts.map +1 -0
- package/dist/serve/runtime/chip-dialog.js +315 -0
- package/dist/serve/runtime/chip-dialog.js.map +1 -0
- package/dist/serve/runtime/chip-install.d.ts +2 -0
- package/dist/serve/runtime/chip-install.d.ts.map +1 -1
- package/dist/serve/runtime/chip-install.js +9 -4
- package/dist/serve/runtime/chip-install.js.map +1 -1
- package/dist/serve/runtime/chip-user-search.d.ts +16 -0
- package/dist/serve/runtime/chip-user-search.d.ts.map +1 -0
- package/dist/serve/runtime/chip-user-search.js +354 -0
- package/dist/serve/runtime/chip-user-search.js.map +1 -0
- package/dist/serve/runtime/chip.d.ts +10 -0
- package/dist/serve/runtime/chip.d.ts.map +1 -1
- package/dist/serve/runtime/chip.js +118 -15
- package/dist/serve/runtime/chip.js.map +1 -1
- package/dist/serve/runtime/identity.d.ts +17 -0
- package/dist/serve/runtime/identity.d.ts.map +1 -0
- package/dist/serve/runtime/identity.js +10 -0
- package/dist/serve/runtime/identity.js.map +1 -0
- package/dist/serve/sandbox-session.d.ts +7 -0
- package/dist/serve/sandbox-session.d.ts.map +1 -1
- package/dist/serve/sandbox-session.js +2 -0
- package/dist/serve/sandbox-session.js.map +1 -1
- package/dist/serve/site-ui/_astro/{RulesCodeEditor.XtDmHOlN.js → RulesCodeEditor.DsTAsKIa.js} +1 -1
- package/dist/serve/site-ui/_astro/app.BOr2kwae.js +115 -0
- package/dist/serve/site-ui/_astro/app.DhAcImFD.js +1 -0
- package/dist/serve/site-ui/_astro/{chess-showcase.B72XYeoh.js → chess-showcase.Bn_pP6UJ.js} +2 -2
- package/dist/serve/site-ui/_astro/{example-runtime.C25_lx6Z.js → example-runtime.CXopTGv7.js} +1 -1
- package/dist/serve/site-ui/_astro/sandbox-controls.rOuZTOUG.js +510 -0
- package/dist/serve/site-ui/_astro/{seed.Co0yUJY5.js → seed.03a08f9t.js} +2 -2
- package/dist/serve/site-ui/_astro/writes.BsPBG3dp.js +653 -0
- package/dist/serve/site-ui/auth/index.html +1 -1
- package/dist/serve/site-ui/docs/_rhythm/index.html +1 -1
- package/dist/serve/site-ui/docs/agent/set-up-your-agent/index.html +1 -1
- package/dist/serve/site-ui/docs/agent/watch-and-review/index.html +1 -1
- package/dist/serve/site-ui/docs/agent/work-with-an-agent/index.html +1 -1
- package/dist/serve/site-ui/docs/ai-compat/index.html +1 -1
- package/dist/serve/site-ui/docs/api-reference/index.html +8 -1
- package/dist/serve/site-ui/docs/api-reference.md +7 -0
- package/dist/serve/site-ui/docs/app-compat/index.html +1 -1
- package/dist/serve/site-ui/docs/auth-compat/index.html +3 -3
- package/dist/serve/site-ui/docs/auth-compat.md +2 -2
- package/dist/serve/site-ui/docs/build/ai-logic/index.html +6 -1
- package/dist/serve/site-ui/docs/build/ai-logic.md +6 -0
- package/dist/serve/site-ui/docs/build/authentication/index.html +1 -1
- package/dist/serve/site-ui/docs/build/cloud-firestore/index.html +1 -1
- package/dist/serve/site-ui/docs/build/cloud-messaging/index.html +1 -1
- package/dist/serve/site-ui/docs/build/cloud-storage/index.html +1 -1
- package/dist/serve/site-ui/docs/build/realtime-database/index.html +1 -1
- package/dist/serve/site-ui/docs/conformance-scores/index.html +6 -2
- package/dist/serve/site-ui/docs/conformance-scores.md +5 -1
- package/dist/serve/site-ui/docs/create-pyric-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/database-compat/index.html +44 -44
- package/dist/serve/site-ui/docs/database-compat.md +43 -43
- package/dist/serve/site-ui/docs/examples/chess/index.html +1 -1
- package/dist/serve/site-ui/docs/examples/index.html +1 -1
- package/dist/serve/site-ui/docs/firestore-compat/index.html +4 -4
- package/dist/serve/site-ui/docs/firestore-compat.md +3 -3
- package/dist/serve/site-ui/docs/firestore-flutter-compat/index.html +319 -0
- package/dist/serve/site-ui/docs/firestore-flutter-compat.md +344 -0
- package/dist/serve/site-ui/docs/functions-rtdb-compat/index.html +1 -1
- package/dist/serve/site-ui/docs/get-started/backend-bundlers/index.html +105 -0
- package/dist/serve/site-ui/docs/get-started/backend-bundlers.md +165 -0
- package/dist/serve/site-ui/docs/get-started/how-the-swap-works/index.html +1 -1
- package/dist/serve/site-ui/docs/get-started/nextjs/index.html +1 -1
- package/dist/serve/site-ui/docs/get-started/start-building/index.html +1 -1
- package/dist/serve/site-ui/docs/get-started/vite/index.html +1 -1
- package/dist/serve/site-ui/docs/index.json +2967 -1482
- package/dist/serve/site-ui/docs/messaging-compat/index.html +1 -1
- package/dist/serve/site-ui/docs/observe/resolve-runtime-status/index.html +1 -1
- package/dist/serve/site-ui/docs/observe/see-whats-happening/index.html +1 -1
- package/dist/serve/site-ui/docs/observe/shape-your-data/index.html +1 -1
- package/dist/serve/site-ui/docs/overview/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-admin-app-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-admin-auth-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-admin-database-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-admin-firestore-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-admin-messaging-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-admin-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-admin-storage-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ai-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ai-scripting-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-analytics-reference-api/index.html +124 -0
- package/dist/serve/site-ui/docs/pyric-analytics-reference-api.md +287 -0
- package/dist/serve/site-ui/docs/pyric-app-check-reference-api/index.html +87 -0
- package/dist/serve/site-ui/docs/pyric-app-check-reference-api.md +199 -0
- package/dist/serve/site-ui/docs/pyric-app-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-auth-reference-api/index.html +6 -2
- package/dist/serve/site-ui/docs/pyric-auth-reference-api.md +2 -1
- package/dist/serve/site-ui/docs/pyric-cli-assurance-browser-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-assurance-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-bridge-client-reference-api/index.html +2 -2
- package/dist/serve/site-ui/docs/pyric-cli-bridge-client-reference-api.md +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-bridge-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-bundler-reference-api/index.html +56 -0
- package/dist/serve/site-ui/docs/pyric-cli-bundler-reference-api.md +72 -0
- package/dist/serve/site-ui/docs/pyric-cli-conformance-browser-reference-api/index.html +2 -1
- package/dist/serve/site-ui/docs/pyric-cli-conformance-browser-reference-api.md +1 -0
- package/dist/serve/site-ui/docs/pyric-cli-conformance-docs-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-conformance-reference-api/index.html +2 -1
- package/dist/serve/site-ui/docs/pyric-cli-conformance-reference-api.md +1 -0
- package/dist/serve/site-ui/docs/pyric-cli-credentials-node-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-discover-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-next-reference-api/index.html +2 -2
- package/dist/serve/site-ui/docs/pyric-cli-next-reference-api.md +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-register-app-bridge-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-register-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-remote-reference-api/index.html +34 -9
- package/dist/serve/site-ui/docs/pyric-cli-remote-reference-api.md +16 -8
- package/dist/serve/site-ui/docs/pyric-cli-serve-worker-reference-api/index.html +133 -93
- package/dist/serve/site-ui/docs/pyric-cli-serve-worker-reference-api.md +61 -1
- package/dist/serve/site-ui/docs/pyric-cli-verify-reference-api/index.html +2 -2
- package/dist/serve/site-ui/docs/pyric-cli-verify-reference-api.md +1 -1
- package/dist/serve/site-ui/docs/pyric-cli-vite-reference-api/index.html +2 -2
- package/dist/serve/site-ui/docs/pyric-cli-vite-reference-api.md +2 -2
- package/dist/serve/site-ui/docs/pyric-database-reference-api/index.html +2 -2
- package/dist/serve/site-ui/docs/pyric-database-reference-api.md +1 -1
- package/dist/serve/site-ui/docs/pyric-firestore-lite-reference-api/index.html +559 -0
- package/dist/serve/site-ui/docs/pyric-firestore-lite-reference-api.md +1240 -0
- package/dist/serve/site-ui/docs/pyric-firestore-reference-api/index.html +40 -11
- package/dist/serve/site-ui/docs/pyric-firestore-reference-api.md +18 -8
- package/dist/serve/site-ui/docs/pyric-functions-reference-api/index.html +67 -0
- package/dist/serve/site-ui/docs/pyric-functions-reference-api.md +149 -0
- package/dist/serve/site-ui/docs/pyric-messaging-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-messaging-sw-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-performance-reference-api/index.html +35 -0
- package/dist/serve/site-ui/docs/pyric-performance-reference-api.md +69 -0
- package/dist/serve/site-ui/docs/pyric-remote-config-reference-api/index.html +132 -0
- package/dist/serve/site-ui/docs/pyric-remote-config-reference-api.md +307 -0
- package/dist/serve/site-ui/docs/pyric-rules-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-sandbox-database-reference-api/index.html +52 -17
- package/dist/serve/site-ui/docs/pyric-sandbox-database-reference-api.md +48 -9
- package/dist/serve/site-ui/docs/pyric-sandbox-firestore-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-sandbox-reference-api/index.html +239 -49
- package/dist/serve/site-ui/docs/pyric-sandbox-reference-api.md +148 -31
- package/dist/serve/site-ui/docs/pyric-storage-reference-api/index.html +22 -4
- package/dist/serve/site-ui/docs/pyric-storage-reference-api.md +24 -2
- package/dist/serve/site-ui/docs/pyric-ui-agents-reference-api/index.html +26 -96
- package/dist/serve/site-ui/docs/pyric-ui-agents-reference-api.md +20 -51
- package/dist/serve/site-ui/docs/pyric-ui-auth-hooks-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-auth-reference-api/index.html +2 -2
- package/dist/serve/site-ui/docs/pyric-ui-auth-reference-api.md +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-events-hooks-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-events-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-firestore-hooks-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-firestore-reference-api/index.html +2 -2
- package/dist/serve/site-ui/docs/pyric-ui-firestore-reference-api.md +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-primitives-reference-api/index.html +124 -26
- package/dist/serve/site-ui/docs/pyric-ui-primitives-reference-api.md +58 -5
- package/dist/serve/site-ui/docs/pyric-ui-rtdb-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-rules-hooks-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-rules-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-storage-hooks-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-storage-reference-api/index.html +4 -5
- package/dist/serve/site-ui/docs/pyric-ui-storage-reference-api.md +3 -4
- package/dist/serve/site-ui/docs/pyric-ui-traffic-hooks-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/pyric-ui-traffic-reference-api/index.html +1 -1
- package/dist/serve/site-ui/docs/reference/cli/index.html +6 -3
- package/dist/serve/site-ui/docs/reference/cli.md +8 -2
- package/dist/serve/site-ui/docs/rules-compat/index.html +10 -2
- package/dist/serve/site-ui/docs/rules-compat.md +9 -1
- package/dist/serve/site-ui/docs/secure/audit-your-rules/index.html +1 -1
- package/dist/serve/site-ui/docs/secure/firestore-rules-limits/index.html +1 -1
- package/dist/serve/site-ui/docs/secure/read-a-denial/index.html +1 -1
- package/dist/serve/site-ui/docs/secure/rtdb-rules-in-typescript/index.html +1 -1
- package/dist/serve/site-ui/docs/secure/rules-standard-library/index.html +1 -1
- package/dist/serve/site-ui/docs/secure/secure-it-with-rules/index.html +1 -1
- package/dist/serve/site-ui/docs/secure/simulate-and-lint/index.html +1 -1
- package/dist/serve/site-ui/docs/secure/write-a-rules-test-suite/index.html +1 -1
- package/dist/serve/site-ui/docs/ship/ship-to-production/index.html +1 -1
- package/dist/serve/site-ui/docs/ship/test-in-node/index.html +1 -1
- package/dist/serve/site-ui/docs/storage-compat/index.html +13 -13
- package/dist/serve/site-ui/docs/storage-compat.md +12 -12
- package/dist/serve/site-ui/docs/trust/how-we-know-it-matches-firebase/index.html +1 -1
- package/dist/serve/site-ui/docs/trust/rules-standard-library/index.html +1 -1
- package/dist/serve/site-ui/docs/trust/versioning-and-compatibility/index.html +1 -1
- package/dist/serve/site-ui/docs/tutorial/index.html +1 -1
- package/dist/serve/site-ui/examples/chess/index.html +1 -1
- package/dist/serve/site-ui/firestore/index.html +1 -1
- package/dist/serve/site-ui/llms.txt +9 -0
- package/dist/serve/site-ui/rtdb/index.html +1 -1
- package/dist/serve/site-ui/settings/index.html +1 -1
- package/dist/serve/site-ui/storage/index.html +1 -1
- package/dist/serve/site-ui/studio/index.html +1 -1
- package/dist/serve/site-ui/traffic/index.html +1 -1
- package/dist/serve/studio/disk-workspace.d.ts.map +1 -1
- package/dist/serve/studio/disk-workspace.js +64 -2
- package/dist/serve/studio/disk-workspace.js.map +1 -1
- package/dist/serve/vite-plugin.d.ts +7 -7
- package/dist/serve/vite-plugin.js +1 -1
- package/dist/serve/vite-plugin.js.map +1 -1
- package/dist/serve/vite-sandbox-generation.d.ts.map +1 -1
- package/dist/serve/vite-sandbox-generation.js +12 -0
- package/dist/serve/vite-sandbox-generation.js.map +1 -1
- package/dist/serve/worker/client/auth.js +1 -2
- package/dist/serve/worker/client/auth.js.map +1 -1
- package/dist/serve/worker/client/core.d.ts +21 -1
- package/dist/serve/worker/client/core.d.ts.map +1 -1
- package/dist/serve/worker/client/core.js +79 -3
- package/dist/serve/worker/client/core.js.map +1 -1
- package/dist/serve/worker/client.d.ts +1 -1
- package/dist/serve/worker/client.d.ts.map +1 -1
- package/dist/serve/worker/client.js +1 -1
- package/dist/serve/worker/client.js.map +1 -1
- package/dist/serve/worker/context-resolver.d.ts +30 -0
- package/dist/serve/worker/context-resolver.d.ts.map +1 -0
- package/dist/serve/worker/context-resolver.js +44 -0
- package/dist/serve/worker/context-resolver.js.map +1 -0
- package/dist/serve/worker/entry.js +23 -19
- package/dist/serve/worker/entry.js.map +1 -1
- package/dist/serve/worker/host/core.d.ts +1 -0
- package/dist/serve/worker/host/core.d.ts.map +1 -1
- package/dist/serve/worker/host/core.js +12 -6
- package/dist/serve/worker/host/core.js.map +1 -1
- package/dist/serve/worker/host/storage.js +2 -2
- package/dist/serve/worker/host-auth.js +1 -2
- package/dist/serve/worker/host-auth.js.map +1 -1
- package/dist/serve/worker/index.d.ts +1 -1
- package/dist/serve/worker/index.d.ts.map +1 -1
- package/dist/serve/worker/index.js +2 -2
- package/dist/serve/worker/index.js.map +1 -1
- package/dist/serve/worker/port-lifecycle.d.ts +18 -0
- package/dist/serve/worker/port-lifecycle.d.ts.map +1 -0
- package/dist/serve/worker/port-lifecycle.js +28 -0
- package/dist/serve/worker/port-lifecycle.js.map +1 -0
- package/dist/serve/worker/serve-init.d.ts.map +1 -1
- package/dist/serve/worker/serve-init.js +8 -2
- package/dist/serve/worker/serve-init.js.map +1 -1
- package/dist/verify/fixture.d.ts +1 -1
- package/package.json +16 -5
- package/src/assurance/.generated/conformance-verdicts.ts +68 -1
- package/src/bridge/client/dispatch.ts +52 -56
- package/src/bridge/client/tool-family-factories.ts +34 -0
- package/src/bridge/server/mcp-contract.ts +15 -59
- package/src/bridge/server/peer.ts +24 -1
- package/src/bridge/server/tool-family-factories.ts +40 -0
- package/src/bridge/server/tool-metadata.ts +29 -61
- package/src/bridge/tool-families.generated.ts +17 -0
- package/src/bridge/tool-families.ts +87 -0
- package/src/bridge/tool-family-records/conformance.ts +6 -0
- package/src/bridge/tool-family-records/firestore-data.ts +15 -0
- package/src/bridge/tool-family-records/firestore-inspect.ts +6 -0
- package/src/bridge/tool-family-records/firestore-rules.ts +15 -0
- package/src/bridge/tool-family-records/firestore-simulator.ts +16 -0
- package/src/bridge/tool-family-records/rtdb-inspection.ts +6 -0
- package/src/bundler/externals.ts +55 -0
- package/src/bundler/index.ts +21 -0
- package/src/cli/cli.test.ts +0 -44
- package/src/cli/inlined-sdk-scanner.ts +77 -0
- package/src/cli/sandbox-interlock.ts +167 -0
- package/src/cli/sandbox-runner.ts +37 -26
- package/src/cli/serve.ts +68 -69
- package/src/cli/unsupported-runtime.ts +68 -0
- package/src/conformance/.generated/can-i-use-browser.ts +2 -2
- package/src/conformance/.generated/can-i-use.ts +2 -2
- package/src/conformance/.generated/conformance-docs.ts +1 -1
- package/src/functions-rtdb/child.ts +115 -21
- package/src/functions-rtdb/development-runtime.ts +4 -0
- package/src/google-endpoints.ts +155 -0
- package/src/next/runtime-env.ts +5 -0
- package/src/next/with-pyric.ts +1 -1
- package/src/register/beacon.ts +232 -0
- package/src/register/index.ts +68 -6
- package/src/register/net-guard.ts +567 -0
- package/src/serve/ai-diagnostics-relay.ts +243 -0
- package/src/serve/ai-proxy.ts +327 -0
- package/src/serve/ai-status.ts +109 -0
- package/src/serve/ai-terminal-blocks.ts +210 -0
- package/src/serve/ai-terminal-text.ts +52 -0
- package/src/serve/beacon-route.ts +141 -0
- package/src/serve/entries/active-auth-registry.ts +56 -0
- package/src/serve/entries/active-auth.ts +100 -0
- package/src/serve/entries/auth-helper-core.ts +5 -0
- package/src/serve/entries/auth-helper-dom.ts +26 -2
- package/src/serve/entries/auth.ts +8 -0
- package/src/serve/entries/bridge-url.ts +1 -1
- package/src/serve/entries/init.ts +78 -3
- package/src/serve/entries/runtime.ts +10 -0
- package/src/serve/namespace.ts +73 -140
- package/src/serve/runtime/chip-config.ts +16 -2
- package/src/serve/runtime/chip-dialog.ts +366 -0
- package/src/serve/runtime/chip-install.ts +10 -4
- package/src/serve/runtime/chip-user-search.ts +391 -0
- package/src/serve/runtime/chip.ts +140 -15
- package/src/serve/runtime/identity.ts +26 -0
- package/src/serve/sandbox-session.ts +9 -0
- package/src/serve/studio/disk-workspace.ts +76 -2
- package/src/serve/vite-plugin.ts +8 -8
- package/src/serve/vite-sandbox-generation.ts +15 -0
- package/src/serve/worker/client/auth.ts +1 -1
- package/src/serve/worker/client/core.ts +80 -3
- package/src/serve/worker/client.ts +1 -1
- package/src/serve/worker/context-resolver.ts +60 -0
- package/src/serve/worker/entry.ts +22 -18
- package/src/serve/worker/host/core.ts +9 -7
- package/src/serve/worker/host/storage.ts +2 -2
- package/src/serve/worker/host-auth.ts +1 -1
- package/src/serve/worker/index.ts +4 -1
- package/src/serve/worker/port-lifecycle.ts +45 -0
- package/src/serve/worker/serve-init.ts +9 -2
- package/src/verify/fixture.ts +1 -1
- package/dist/serve/site-ui/_astro/app.B52xr-DK.js +0 -1
- package/dist/serve/site-ui/_astro/app.DWBraPUw.js +0 -12
- package/dist/serve/site-ui/_astro/sandbox-controls.DEpnKg-O.js +0 -1169
- package/dist/serve/site-ui/_astro/writes.rpjrFzmu.js +0 -102
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
<link rel="stylesheet" href="/__pyric/ui/_astro/_slug_.Da5VLhW1.css">
|
|
3
3
|
<style>:root{--rhythm-para: .875rem;--rhythm-group: 1.5rem;--rhythm-subsection: 2.25rem;--rhythm-section: 3.25rem;--rhythm-list: calc(var(--rhythm-para) * .75)}.prose>*,.prose blockquote>*,.prose li>*,.prose .compat-stat>*{margin-block:0}.prose>*+*{margin-block-start:var(--rhythm-group)}.prose>*+h2{margin-block-start:var(--rhythm-section)}.prose>*+h3,.prose>*+h4{margin-block-start:var(--rhythm-subsection)}.prose>h1+*,.prose>h2+*,.prose>h3+*,.prose>h4+*{margin-block-start:var(--rhythm-para)}.prose>p+p{margin-block-start:var(--rhythm-para)}.prose>p+ul,.prose>p+ol,.prose>p+blockquote{margin-block-start:var(--rhythm-para)}.prose li+li{margin-block-start:var(--rhythm-list)}.prose li>ul,.prose li>ol{margin-block-start:var(--rhythm-list)}.prose li>*+*,.prose blockquote>*+*{margin-block-start:var(--rhythm-para)}
|
|
4
4
|
html{scrollbar-gutter:stable}
|
|
5
|
-
</style></head> <body> <header class="studio__chrome"> <div class="studio__bar"> <div class="studio__chrome-inner"> <nav class="studio__nav" aria-label="Site"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric">pyric</a> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a><a class="studio__nav-tab" href="/__pyric/ui/studio"> Studio </a> </nav> </div> </div> </header> <div class="docs-shell" data-astro-cid-mw7aashj> <details class="docs-nav-drawer" data-astro-cid-mw7aashj> <summary data-astro-cid-mw7aashj>Navigate</summary> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <script type="module">let i=null;function d(t){return i||(i=fetch(t).then(e=>e.json())),i}function l(t,e){return t.title.toLowerCase().includes(e)||t.excerpt.toLowerCase().includes(e)?!0:t.headings.some(r=>r.text.toLowerCase().includes(e))}function u(t,e,r){if(e.innerHTML="",t.length===0){e.hidden=!1;{const n=document.createElement("li");n.className="docs-search-empty",n.textContent="No matches",e.appendChild(n)}return}e.hidden=!1;for(const n of t.slice(0,8)){const s=document.createElement("li"),c=document.createElement("a");c.href=n.path;const o=document.createElement("span");o.className="docs-search-result-title",o.textContent=n.title;const a=document.createElement("span");a.className="docs-search-result-meta",a.textContent=[n.group,n.section].filter(Boolean).join(" / "),c.append(o,a),s.appendChild(c),e.appendChild(s)}}document.querySelectorAll(".docs-search").forEach(t=>{const e=t.dataset.indexUrl,r=t.querySelector(".docs-search-input"),n=t.querySelector(".docs-search-results");r.addEventListener("input",async()=>{const s=r.value.trim().toLowerCase();if(!s){n.hidden=!0,n.innerHTML="";return}const{pages:c}=await d(e);r.value.trim().toLowerCase()===s&&u(c.filter(o=>l(o,s)),n)}),r.addEventListener("focus",()=>{d(e),n.childElementCount>0&&(n.hidden=!1)}),r.addEventListener("keydown",s=>{s.key==="Escape"&&(r.value="",n.hidden=!0,n.innerHTML="",r.blur())}),r.addEventListener("blur",()=>{window.setTimeout(()=>{n.hidden=!0},150)})});document.addEventListener("keydown",t=>{if(!(t.metaKey||t.ctrlKey)||t.key.toLowerCase()!=="k")return;const e=[...document.querySelectorAll(".docs-search-input")].find(r=>r.offsetParent!==null);e&&(t.preventDefault(),e.focus(),e.select())});</script> <details class="docs-nav-group"> <summary>Overview</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/overview/"> Overview </a> </li><li> <a href="/__pyric/ui/docs/tutorial/"> Tutorial </a> </li><li> <a href="/__pyric/ui/docs/examples/"> Examples </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/vite/"> Vite </a> </li><li> <a href="/__pyric/ui/docs/get-started/nextjs/"> Next.js </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Examples </h2> <ul> <li> <a href="/__pyric/ui/docs/examples/chess/"> Chess showcase </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/resolve-runtime-status/"> Runtime status </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Trust</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Versioning and the fb tag </a> </li><li> <a href="/__pyric/ui/docs/trust/rules-standard-library/"> Rules standard library reference </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-reference-api/"> pyric-admin </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-messaging-reference-api/"> pyric-admin/messaging </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-next-reference-api/"> @pyric/cli/next </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/" aria-current="page"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-app-bridge-reference-api/"> @pyric/cli/register/app-bridge </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/reference/cli/"> CLI </a> </li> </ul> </div> </div> </details> </nav> </details> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <details class="docs-nav-group" id="nav-group-overview"> <summary>Overview</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/overview/"> Overview </a> </li><li> <a href="/__pyric/ui/docs/tutorial/"> Tutorial </a> </li><li> <a href="/__pyric/ui/docs/examples/"> Examples </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-get-started"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/vite/"> Vite </a> </li><li> <a href="/__pyric/ui/docs/get-started/nextjs/"> Next.js </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-build"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-secure-debug"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-secure-debug-examples"> Examples </h2> <ul> <li> <a href="/__pyric/ui/docs/examples/chess/"> Chess showcase </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-observe-shape"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/resolve-runtime-status/"> Runtime status </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-test"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-work-with-an-agent"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-trust"> <summary>Trust</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Versioning and the fb tag </a> </li><li> <a href="/__pyric/ui/docs/trust/rules-standard-library/"> Rules standard library reference </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" id="nav-group-reference" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-reference-api/"> pyric-admin </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-messaging-reference-api/"> pyric-admin/messaging </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-next-reference-api/"> @pyric/cli/next </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/" aria-current="page"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-app-bridge-reference-api/"> @pyric/cli/register/app-bridge </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/reference/cli/"> CLI </a> </li> </ul> </div> </div> </details> </nav> <main class="doc-main" data-astro-cid-mw7aashj> <nav class="docs-breadcrumbs" aria-label="Breadcrumb"> <ol> <li> <a href="/__pyric/ui/docs/api-reference/">API reference</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>@pyric/cli</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">@pyric/cli/serve/worker</span> </li> </ol> </nav> <header class="api-reference-header" data-astro-cid-mw7aashj> <p class="api-reference-kicker" data-astro-cid-mw7aashj>API reference</p> <h1 data-astro-cid-mw7aashj><code data-astro-cid-mw7aashj>@pyric/cli/serve/worker</code></h1> <p class="api-reference-meta" data-astro-cid-mw7aashj> 175 published symbols from <code data-astro-cid-mw7aashj>@pyric/cli</code> </p> <p class="api-reference-source" data-astro-cid-mw7aashj>
|
|
5
|
+
</style></head> <body> <header class="studio__chrome"> <div class="studio__bar"> <div class="studio__chrome-inner"> <nav class="studio__nav" aria-label="Site"> <a class="studio__brand" href="/__pyric/ui/" aria-label="Pyric">pyric</a> <a class="studio__nav-tab" href="/__pyric/ui/"> Home </a><a class="studio__nav-tab" href="/__pyric/ui/docs" aria-current="page"> Docs </a><a class="studio__nav-tab" href="/__pyric/ui/studio"> Studio </a> </nav> </div> </div> </header> <div class="docs-shell" data-astro-cid-mw7aashj> <details class="docs-nav-drawer" data-astro-cid-mw7aashj> <summary data-astro-cid-mw7aashj>Navigate</summary> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <script type="module">let i=null;function d(t){return i||(i=fetch(t).then(e=>e.json())),i}function l(t,e){return t.title.toLowerCase().includes(e)||t.excerpt.toLowerCase().includes(e)?!0:t.headings.some(r=>r.text.toLowerCase().includes(e))}function u(t,e,r){if(e.innerHTML="",t.length===0){e.hidden=!1;{const n=document.createElement("li");n.className="docs-search-empty",n.textContent="No matches",e.appendChild(n)}return}e.hidden=!1;for(const n of t.slice(0,8)){const s=document.createElement("li"),c=document.createElement("a");c.href=n.path;const o=document.createElement("span");o.className="docs-search-result-title",o.textContent=n.title;const a=document.createElement("span");a.className="docs-search-result-meta",a.textContent=[n.group,n.section].filter(Boolean).join(" / "),c.append(o,a),s.appendChild(c),e.appendChild(s)}}document.querySelectorAll(".docs-search").forEach(t=>{const e=t.dataset.indexUrl,r=t.querySelector(".docs-search-input"),n=t.querySelector(".docs-search-results");r.addEventListener("input",async()=>{const s=r.value.trim().toLowerCase();if(!s){n.hidden=!0,n.innerHTML="";return}const{pages:c}=await d(e);r.value.trim().toLowerCase()===s&&u(c.filter(o=>l(o,s)),n)}),r.addEventListener("focus",()=>{d(e),n.childElementCount>0&&(n.hidden=!1)}),r.addEventListener("keydown",s=>{s.key==="Escape"&&(r.value="",n.hidden=!0,n.innerHTML="",r.blur())}),r.addEventListener("blur",()=>{window.setTimeout(()=>{n.hidden=!0},150)})});document.addEventListener("keydown",t=>{if(!(t.metaKey||t.ctrlKey)||t.key.toLowerCase()!=="k")return;const e=[...document.querySelectorAll(".docs-search-input")].find(r=>r.offsetParent!==null);e&&(t.preventDefault(),e.focus(),e.select())});</script> <details class="docs-nav-group"> <summary>Overview</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/overview/"> Overview </a> </li><li> <a href="/__pyric/ui/docs/tutorial/"> Tutorial </a> </li><li> <a href="/__pyric/ui/docs/examples/"> Examples </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/vite/"> Vite </a> </li><li> <a href="/__pyric/ui/docs/get-started/nextjs/"> Next.js </a> </li><li> <a href="/__pyric/ui/docs/get-started/backend-bundlers/"> Backend bundlers </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading"> Examples </h2> <ul> <li> <a href="/__pyric/ui/docs/examples/chess/"> Chess showcase </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/resolve-runtime-status/"> Runtime status </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Trust</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Versioning and the fb tag </a> </li><li> <a href="/__pyric/ui/docs/trust/rules-standard-library/"> Rules standard library reference </a> </li> </ul> </div> </div> </details><details class="docs-nav-group"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/firestore-flutter-compat/"> Firestore · Flutter </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-lite-reference-api/"> pyric/firestore/lite </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-check-reference-api/"> pyric/app-check </a> </li><li> <a href="/__pyric/ui/docs/pyric-functions-reference-api/"> pyric/functions </a> </li><li> <a href="/__pyric/ui/docs/pyric-analytics-reference-api/"> pyric/analytics </a> </li><li> <a href="/__pyric/ui/docs/pyric-performance-reference-api/"> pyric/performance </a> </li><li> <a href="/__pyric/ui/docs/pyric-remote-config-reference-api/"> pyric/remote-config </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-reference-api/"> pyric-admin </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-messaging-reference-api/"> pyric-admin/messaging </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-next-reference-api/"> @pyric/cli/next </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bundler-reference-api/"> @pyric/cli/bundler </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/" aria-current="page"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-app-bridge-reference-api/"> @pyric/cli/register/app-bridge </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/reference/cli/"> CLI </a> </li> </ul> </div> </div> </details> </nav> </details> <nav class="docs-nav" aria-label="Documentation"> <div class="docs-search" data-index-url="/__pyric/ui/docs/index.json"> <div class="docs-search-field"> <svg class="docs-search-icon" viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"> <path d="M11.5 11.5 15 15M13 7A6 6 0 1 1 1 7a6 6 0 0 1 12 0Z" fill="none" stroke="currentColor" stroke-width="1.4" stroke-linecap="round"></path> </svg> <input type="text" class="docs-search-input" placeholder="Search docs" aria-label="Search docs" autocomplete="off" spellcheck="false"> <kbd class="docs-search-kbd">⌘K</kbd> </div> <ul class="docs-search-results" hidden></ul> </div> <details class="docs-nav-group" id="nav-group-overview"> <summary>Overview</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/overview/"> Overview </a> </li><li> <a href="/__pyric/ui/docs/tutorial/"> Tutorial </a> </li><li> <a href="/__pyric/ui/docs/examples/"> Examples </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-get-started"> <summary>Get started</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/get-started/start-building/"> Quickstart </a> </li><li> <a href="/__pyric/ui/docs/get-started/vite/"> Vite </a> </li><li> <a href="/__pyric/ui/docs/get-started/nextjs/"> Next.js </a> </li><li> <a href="/__pyric/ui/docs/get-started/backend-bundlers/"> Backend bundlers </a> </li><li> <a href="/__pyric/ui/docs/get-started/how-the-swap-works/"> How the swap works </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-build"> <summary>Build</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/build/authentication/"> Authentication </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-firestore/"> Cloud Firestore </a> </li><li> <a href="/__pyric/ui/docs/build/realtime-database/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-storage/"> Cloud Storage </a> </li><li> <a href="/__pyric/ui/docs/build/cloud-messaging/"> Cloud Messaging </a> </li><li> <a href="/__pyric/ui/docs/build/ai-logic/"> AI Logic </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-secure-debug"> <summary>Secure & debug</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/secure/secure-it-with-rules/"> Security Rules </a> </li><li> <a href="/__pyric/ui/docs/secure/simulate-and-lint/"> Simulate and lint before you deploy </a> </li><li> <a href="/__pyric/ui/docs/secure/write-a-rules-test-suite/"> Write a rules test suite </a> </li><li> <a href="/__pyric/ui/docs/secure/read-a-denial/"> Read a denial and understand it </a> </li><li> <a href="/__pyric/ui/docs/secure/rules-standard-library/"> The rules standard library </a> </li><li> <a href="/__pyric/ui/docs/secure/rtdb-rules-in-typescript/"> RTDB rules in TypeScript </a> </li><li> <a href="/__pyric/ui/docs/secure/firestore-rules-limits/"> Rules limits </a> </li><li> <a href="/__pyric/ui/docs/secure/audit-your-rules/"> Audit rules and data </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading" id="nav-section-secure-debug-examples"> Examples </h2> <ul> <li> <a href="/__pyric/ui/docs/examples/chess/"> Chess showcase </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-observe-shape"> <summary>Observe & shape</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/observe/see-whats-happening/"> Traffic & rule verdicts </a> </li><li> <a href="/__pyric/ui/docs/observe/resolve-runtime-status/"> Runtime status </a> </li><li> <a href="/__pyric/ui/docs/observe/shape-your-data/"> Seed, snapshot, replay </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-ship-test"> <summary>Ship & test</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/ship/ship-to-production/"> Ship to production </a> </li><li> <a href="/__pyric/ui/docs/ship/test-in-node/"> Test in Node </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-work-with-an-agent"> <summary>Work with an agent</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/agent/set-up-your-agent/"> Connect an agent </a> </li><li> <a href="/__pyric/ui/docs/agent/work-with-an-agent/"> Use the MCP tools </a> </li><li> <a href="/__pyric/ui/docs/agent/watch-and-review/"> Watch in Pyric Studio </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-trust"> <summary>Trust</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/trust/versioning-and-compatibility/"> Versioning and the fb tag </a> </li><li> <a href="/__pyric/ui/docs/trust/rules-standard-library/"> Rules standard library reference </a> </li> </ul> </div> </div> </details><details class="docs-nav-group" id="nav-group-conformance"> <summary>Conformance</summary> <div class="docs-nav-group-body"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/conformance-scores/"> Conformance scores </a> </li><li> <a href="/__pyric/ui/docs/trust/how-we-know-it-matches-firebase/"> How we know it matches Firebase </a> </li><li> <a href="/__pyric/ui/docs/app-compat/"> App </a> </li><li> <a href="/__pyric/ui/docs/ai-compat/"> AI Logic </a> </li><li> <a href="/__pyric/ui/docs/auth-compat/"> Auth </a> </li><li> <a href="/__pyric/ui/docs/firestore-compat/"> Firestore </a> </li><li> <a href="/__pyric/ui/docs/database-compat/"> Realtime Database </a> </li><li> <a href="/__pyric/ui/docs/storage-compat/"> Storage </a> </li><li> <a href="/__pyric/ui/docs/messaging-compat/"> Messaging </a> </li><li> <a href="/__pyric/ui/docs/functions-rtdb-compat/"> Functions · RTDB </a> </li><li> <a href="/__pyric/ui/docs/rules-compat/"> Rules </a> </li><li> <a href="/__pyric/ui/docs/firestore-flutter-compat/"> Firestore · Flutter </a> </li> </ul> </div> </div> </details> <details class="docs-nav-group" id="nav-group-reference" open> <summary>Reference</summary> <div class="docs-nav-group-body docs-nav-group-body--reference"> <div class="docs-nav-section"> <ul> <li> <a href="/__pyric/ui/docs/api-reference/"> API reference </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-app-reference-api/"> pyric/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-reference-api/"> pyric/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-firestore-lite-reference-api/"> pyric/firestore/lite </a> </li><li> <a href="/__pyric/ui/docs/pyric-auth-reference-api/"> pyric/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-reference-api/"> pyric/ai </a> </li><li> <a href="/__pyric/ui/docs/pyric-ai-scripting-reference-api/"> pyric/ai/scripting </a> </li><li> <a href="/__pyric/ui/docs/pyric-database-reference-api/"> pyric/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-storage-reference-api/"> pyric/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-reference-api/"> pyric/messaging </a> </li><li> <a href="/__pyric/ui/docs/pyric-messaging-sw-reference-api/"> pyric/messaging/sw </a> </li><li> <a href="/__pyric/ui/docs/pyric-rules-reference-api/"> pyric/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-reference-api/"> pyric/sandbox </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-firestore-reference-api/"> pyric/sandbox/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-sandbox-database-reference-api/"> pyric/sandbox/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-app-check-reference-api/"> pyric/app-check </a> </li><li> <a href="/__pyric/ui/docs/pyric-functions-reference-api/"> pyric/functions </a> </li><li> <a href="/__pyric/ui/docs/pyric-analytics-reference-api/"> pyric/analytics </a> </li><li> <a href="/__pyric/ui/docs/pyric-performance-reference-api/"> pyric/performance </a> </li><li> <a href="/__pyric/ui/docs/pyric-remote-config-reference-api/"> pyric/remote-config </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">pyric-admin</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-admin-reference-api/"> pyric-admin </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-app-reference-api/"> pyric-admin/app </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-firestore-reference-api/"> pyric-admin/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-auth-reference-api/"> pyric-admin/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-database-reference-api/"> pyric-admin/database </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-storage-reference-api/"> pyric-admin/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-admin-messaging-reference-api/"> pyric-admin/messaging </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">create-pyric</h2> <ul> <li> <a href="/__pyric/ui/docs/create-pyric-reference-api/"> create-pyric </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-cli-credentials-node-reference-api/"> @pyric/cli/credentials/node </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-verify-reference-api/"> @pyric/cli/verify </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-reference-api/"> @pyric/cli/conformance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-browser-reference-api/"> @pyric/cli/conformance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-conformance-docs-reference-api/"> @pyric/cli/conformance/docs </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-reference-api/"> @pyric/cli/assurance </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-assurance-browser-reference-api/"> @pyric/cli/assurance/browser </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-reference-api/"> @pyric/cli/bridge </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bridge-client-reference-api/"> @pyric/cli/bridge/client </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-discover-reference-api/"> @pyric/cli/discover </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-vite-reference-api/"> @pyric/cli/vite </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-next-reference-api/"> @pyric/cli/next </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-bundler-reference-api/"> @pyric/cli/bundler </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-serve-worker-reference-api/" aria-current="page"> @pyric/cli/serve/worker </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-remote-reference-api/"> @pyric/cli/remote </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-reference-api/"> @pyric/cli/register </a> </li><li> <a href="/__pyric/ui/docs/pyric-cli-register-app-bridge-reference-api/"> @pyric/cli/register/app-bridge </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/ui</h2> <ul> <li> <a href="/__pyric/ui/docs/pyric-ui-auth-reference-api/"> @pyric/ui/auth </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-auth-hooks-reference-api/"> @pyric/ui/auth/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-primitives-reference-api/"> @pyric/ui/primitives </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-reference-api/"> @pyric/ui/firestore </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-firestore-hooks-reference-api/"> @pyric/ui/firestore/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rtdb-reference-api/"> @pyric/ui/rtdb </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-reference-api/"> @pyric/ui/storage </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-storage-hooks-reference-api/"> @pyric/ui/storage/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-reference-api/"> @pyric/ui/traffic </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-traffic-hooks-reference-api/"> @pyric/ui/traffic/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-reference-api/"> @pyric/ui/events </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-events-hooks-reference-api/"> @pyric/ui/events/hooks </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-agents-reference-api/"> @pyric/ui/agents </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-reference-api/"> @pyric/ui/rules </a> </li><li> <a href="/__pyric/ui/docs/pyric-ui-rules-hooks-reference-api/"> @pyric/ui/rules/hooks </a> </li> </ul> </div><div class="docs-nav-section"> <h2 class="docs-nav-heading">@pyric/cli</h2> <ul> <li> <a href="/__pyric/ui/docs/reference/cli/"> CLI </a> </li> </ul> </div> </div> </details> </nav> <main class="doc-main" data-astro-cid-mw7aashj> <nav class="docs-breadcrumbs" aria-label="Breadcrumb"> <ol> <li> <a href="/__pyric/ui/docs/api-reference/">API reference</a> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span>@pyric/cli</span> </li><li> <span class="docs-breadcrumbs-sep" aria-hidden="true">/</span> <span aria-current="page">@pyric/cli/serve/worker</span> </li> </ol> </nav> <header class="api-reference-header" data-astro-cid-mw7aashj> <p class="api-reference-kicker" data-astro-cid-mw7aashj>API reference</p> <h1 data-astro-cid-mw7aashj><code data-astro-cid-mw7aashj>@pyric/cli/serve/worker</code></h1> <p class="api-reference-meta" data-astro-cid-mw7aashj> 178 published symbols from <code data-astro-cid-mw7aashj>@pyric/cli</code> </p> <p class="api-reference-source" data-astro-cid-mw7aashj>
|
|
6
6
|
Generated from the TypeScript declarations shipped at this import path.
|
|
7
7
|
</p> </header> <article class="prose api-reference-body" data-astro-cid-mw7aashj> <!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
|
|
8
8
|
<h2 id="classes">Classes</h2>
|
|
@@ -1507,6 +1507,10 @@ this single-backend model (see SESSION/LOCAL collapse note in host.ts).</p>
|
|
|
1507
1507
|
<h4 id="returns-38">Returns</h4>
|
|
1508
1508
|
<p><code>void</code></p>
|
|
1509
1509
|
<h2 id="variables">Variables</h2>
|
|
1510
|
+
<p><a id="auth_lens_storage_key"></a></p>
|
|
1511
|
+
<h3 id="auth_lens_storage_key">AUTH_LENS_STORAGE_KEY</h3>
|
|
1512
|
+
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> AUTH_LENS_STORAGE_KEY</span><span style="color:#ABB2BF">: </span><span style="color:#98C379">"pyric:auth-lens"</span><span style="color:#56B6C2"> =</span><span style="color:#98C379"> "pyric:auth-lens"</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
1513
|
+
<hr>
|
|
1510
1514
|
<p><a id="browserlocalpersistence"></a></p>
|
|
1511
1515
|
<h3 id="browserlocalpersistence">browserLocalPersistence</h3>
|
|
1512
1516
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">const</span><span style="color:#E5C07B"> browserLocalPersistence</span><span style="color:#ABB2BF">: {</span></span>
|
|
@@ -3072,6 +3076,13 @@ worker is older than what’s served (a SharedWorker can’t hot-update).</p>
|
|
|
3072
3076
|
<h4 id="returns-95">Returns</h4>
|
|
3073
3077
|
<p><code>Promise</code><<code>string</code>></p>
|
|
3074
3078
|
<hr>
|
|
3079
|
+
<p><a id="hydratelensfromstorage"></a></p>
|
|
3080
|
+
<h3 id="hydratelensfromstorage">hydrateLensFromStorage()</h3>
|
|
3081
|
+
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> hydrateLensFromStorage</span><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">AuthLens</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
3082
|
+
<p>Read persisted auth lens from sessionStorage safely.</p>
|
|
3083
|
+
<h4 id="returns-96">Returns</h4>
|
|
3084
|
+
<p><a href="/docs/pyric-sandbox-reference-api/#authlens-2"><code>AuthLens</code></a></p>
|
|
3085
|
+
<hr>
|
|
3075
3086
|
<p><a id="importworkerstate"></a></p>
|
|
3076
3087
|
<h3 id="importworkerstate">importWorkerState()</h3>
|
|
3077
3088
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> importWorkerState</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">db</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ClientDb</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75;font-style:italic">bundle</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF"><</span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">>;</span></span></code></pre>
|
|
@@ -3095,7 +3106,7 @@ worker is older than what’s served (a SharedWorker can’t hot-update).</p>
|
|
|
3095
3106
|
|
|
3096
3107
|
|
|
3097
3108
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>bundle</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
3098
|
-
<h4 id="returns-
|
|
3109
|
+
<h4 id="returns-97">Returns</h4>
|
|
3099
3110
|
<p><code>Promise</code><<code>void</code>></p>
|
|
3100
3111
|
<hr>
|
|
3101
3112
|
<p><a id="increment"></a></p>
|
|
@@ -3116,7 +3127,7 @@ worker is older than what’s served (a SharedWorker can’t hot-update).</p>
|
|
|
3116
3127
|
|
|
3117
3128
|
|
|
3118
3129
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>n</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
|
|
3119
|
-
<h4 id="returns-
|
|
3130
|
+
<h4 id="returns-98">Returns</h4>
|
|
3120
3131
|
<p><code>SentinelMarker</code></p>
|
|
3121
3132
|
<hr>
|
|
3122
3133
|
<p><a id="limit"></a></p>
|
|
@@ -3137,7 +3148,7 @@ worker is older than what’s served (a SharedWorker can’t hot-update).</p>
|
|
|
3137
3148
|
|
|
3138
3149
|
|
|
3139
3150
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>n</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
|
|
3140
|
-
<h4 id="returns-
|
|
3151
|
+
<h4 id="returns-99">Returns</h4>
|
|
3141
3152
|
<p><code>QueryConstraintHandle</code></p>
|
|
3142
3153
|
<hr>
|
|
3143
3154
|
<p><a id="limittolast"></a></p>
|
|
@@ -3158,7 +3169,7 @@ worker is older than what’s served (a SharedWorker can’t hot-update).</p>
|
|
|
3158
3169
|
|
|
3159
3170
|
|
|
3160
3171
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>n</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
|
|
3161
|
-
<h4 id="returns-
|
|
3172
|
+
<h4 id="returns-100">Returns</h4>
|
|
3162
3173
|
<p><code>QueryConstraintHandle</code></p>
|
|
3163
3174
|
<hr>
|
|
3164
3175
|
<p><a id="listall"></a></p>
|
|
@@ -3184,7 +3195,7 @@ data browse). The host enforces <code>read</code> rules on the scanned prefix.</
|
|
|
3184
3195
|
|
|
3185
3196
|
|
|
3186
3197
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#clientstoragereference"><code>ClientStorageReference</code></a></td></tr></tbody></table></div>
|
|
3187
|
-
<h4 id="returns-
|
|
3198
|
+
<h4 id="returns-101">Returns</h4>
|
|
3188
3199
|
<p><code>Promise</code><{
|
|
3189
3200
|
<code>items</code>: <a href="#clientstoragereference"><code>ClientStorageReference</code></a>[];
|
|
3190
3201
|
<code>prefixes</code>: <a href="#clientstoragereference"><code>ClientStorageReference</code></a>[];
|
|
@@ -3212,7 +3223,7 @@ lens-independent.</p>
|
|
|
3212
3223
|
|
|
3213
3224
|
|
|
3214
3225
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr></tbody></table></div>
|
|
3215
|
-
<h4 id="returns-
|
|
3226
|
+
<h4 id="returns-102">Returns</h4>
|
|
3216
3227
|
<p><code>Promise</code><<code>string</code>[]></p>
|
|
3217
3228
|
<hr>
|
|
3218
3229
|
<p><a id="listsubcollections"></a></p>
|
|
@@ -3238,7 +3249,7 @@ lens-independent.</p>
|
|
|
3238
3249
|
|
|
3239
3250
|
|
|
3240
3251
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>docPath</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
3241
|
-
<h4 id="returns-
|
|
3252
|
+
<h4 id="returns-103">Returns</h4>
|
|
3242
3253
|
<p><code>Promise</code><<code>string</code>[]></p>
|
|
3243
3254
|
<hr>
|
|
3244
3255
|
<p><a id="listusers"></a></p>
|
|
@@ -3259,7 +3270,7 @@ lens-independent.</p>
|
|
|
3259
3270
|
|
|
3260
3271
|
|
|
3261
3272
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr></tbody></table></div>
|
|
3262
|
-
<h4 id="returns-
|
|
3273
|
+
<h4 id="returns-104">Returns</h4>
|
|
3263
3274
|
<p><code>Promise</code><<a href="/docs/pyric-auth-reference-api/#authuserrecord"><code>AuthUserRecord</code></a>[]></p>
|
|
3264
3275
|
<hr>
|
|
3265
3276
|
<p><a id="listworkerbranches"></a></p>
|
|
@@ -3281,14 +3292,14 @@ lens-independent.</p>
|
|
|
3281
3292
|
|
|
3282
3293
|
|
|
3283
3294
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr></tbody></table></div>
|
|
3284
|
-
<h4 id="returns-
|
|
3295
|
+
<h4 id="returns-105">Returns</h4>
|
|
3285
3296
|
<p><code>Promise</code><<code>string</code>[]></p>
|
|
3286
3297
|
<hr>
|
|
3287
3298
|
<p><a id="mintpresenceclientid"></a></p>
|
|
3288
3299
|
<h3 id="mintpresenceclientid">mintPresenceClientId()</h3>
|
|
3289
3300
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> mintPresenceClientId</span><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
3290
3301
|
<p>Mint a random client id (page-lifetime).</p>
|
|
3291
|
-
<h4 id="returns-
|
|
3302
|
+
<h4 id="returns-106">Returns</h4>
|
|
3292
3303
|
<p><code>string</code></p>
|
|
3293
3304
|
<hr>
|
|
3294
3305
|
<p><a id="onauthstatechanged"></a></p>
|
|
@@ -3318,7 +3329,7 @@ handle’s <code>currentUser</code> mirror before invoking the callback.</p>
|
|
|
3318
3329
|
|
|
3319
3330
|
|
|
3320
3331
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr><tr><td align="left"><code>callback</code></td><td align="left">(<code>user</code>: <a href="#clientuser"><code>ClientUser</code></a>) => <code>void</code></td></tr></tbody></table></div>
|
|
3321
|
-
<h4 id="returns-
|
|
3332
|
+
<h4 id="returns-107">Returns</h4>
|
|
3322
3333
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
3323
3334
|
<hr>
|
|
3324
3335
|
<p><a id="onidtokenchanged"></a></p>
|
|
@@ -3346,7 +3357,7 @@ sessions, #754).</p>
|
|
|
3346
3357
|
|
|
3347
3358
|
|
|
3348
3359
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr><tr><td align="left"><code>callback</code></td><td align="left">(<code>user</code>: <a href="#clientuser"><code>ClientUser</code></a>) => <code>void</code></td></tr></tbody></table></div>
|
|
3349
|
-
<h4 id="returns-
|
|
3360
|
+
<h4 id="returns-108">Returns</h4>
|
|
3350
3361
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
3351
3362
|
<hr>
|
|
3352
3363
|
<p><a id="onsnapshot"></a></p>
|
|
@@ -3386,7 +3397,7 @@ to deregister the listener on the worker side.</p>
|
|
|
3386
3397
|
|
|
3387
3398
|
|
|
3388
3399
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left">| <a href="#docrefhandle"><code>DocRefHandle</code></a> | <a href="#collrefhandle"><code>CollRefHandle</code></a> | <a href="#queryhandle"><code>QueryHandle</code></a></td></tr><tr><td align="left"><code>callback</code></td><td align="left">(<code>snap</code>: | <a href="#clientdocsnapshot"><code>ClientDocSnapshot</code></a> | <a href="#clientquerysnapshot"><code>ClientQuerySnapshot</code></a>) => <code>void</code></td></tr><tr><td align="left"><code>errorCallback?</code></td><td align="left">(<code>err</code>: <code>unknown</code>) => <code>void</code></td></tr></tbody></table></div>
|
|
3389
|
-
<h4 id="returns-
|
|
3400
|
+
<h4 id="returns-109">Returns</h4>
|
|
3390
3401
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
3391
3402
|
<hr>
|
|
3392
3403
|
<p><a id="onworkerruntimereload"></a></p>
|
|
@@ -3408,9 +3419,9 @@ to deregister the listener on the worker side.</p>
|
|
|
3408
3419
|
|
|
3409
3420
|
|
|
3410
3421
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>listener</code></td><td align="left">(<code>epoch</code>: <code>string</code>) => <code>void</code></td></tr></tbody></table></div>
|
|
3411
|
-
<h4 id="returns-
|
|
3422
|
+
<h4 id="returns-110">Returns</h4>
|
|
3412
3423
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
3413
|
-
<h5 id="returns-
|
|
3424
|
+
<h5 id="returns-111">Returns</h5>
|
|
3414
3425
|
<p><code>void</code></p>
|
|
3415
3426
|
<hr>
|
|
3416
3427
|
<p><a id="or"></a></p>
|
|
@@ -3434,7 +3445,7 @@ filters (<code>where()</code>, or nested <code>or()</code>/<code>and()</code>).
|
|
|
3434
3445
|
|
|
3435
3446
|
|
|
3436
3447
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left">…<code>filters</code></td><td align="left"><code>QueryConstraintHandle</code>[]</td></tr></tbody></table></div>
|
|
3437
|
-
<h4 id="returns-
|
|
3448
|
+
<h4 id="returns-112">Returns</h4>
|
|
3438
3449
|
<p><code>QueryConstraintHandle</code></p>
|
|
3439
3450
|
<hr>
|
|
3440
3451
|
<p><a id="orderby"></a></p>
|
|
@@ -3459,7 +3470,7 @@ filters (<code>where()</code>, or nested <code>or()</code>/<code>and()</code>).
|
|
|
3459
3470
|
|
|
3460
3471
|
|
|
3461
3472
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>direction?</code></td><td align="left"><code>"asc"</code> | <code>"desc"</code></td></tr></tbody></table></div>
|
|
3462
|
-
<h4 id="returns-
|
|
3473
|
+
<h4 id="returns-113">Returns</h4>
|
|
3463
3474
|
<p><code>QueryConstraintHandle</code></p>
|
|
3464
3475
|
<hr>
|
|
3465
3476
|
<p><a id="ownclientuntilpagehide"></a></p>
|
|
@@ -3495,18 +3506,18 @@ filters (<code>where()</code>, or nested <code>or()</code>/<code>and()</code>).
|
|
|
3495
3506
|
|
|
3496
3507
|
|
|
3497
3508
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>client</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>events?</code></td><td align="left"><code>PagehideEvents</code></td></tr><tr><td align="left"><code>disconnectClientImpl?</code></td><td align="left"><code>Disconnect</code></td></tr></tbody></table></div>
|
|
3498
|
-
<h4 id="returns-
|
|
3509
|
+
<h4 id="returns-114">Returns</h4>
|
|
3499
3510
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#ABB2BF">{</span></span>
|
|
3500
3511
|
<span class="line"><span style="color:#E06C75"> disconnect</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2"><</span><span style="color:#C678DD">void</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span>
|
|
3501
3512
|
<span class="line"><span style="color:#E06C75"> dispose</span><span style="color:#ABB2BF">: </span><span style="color:#C678DD">void</span><span style="color:#ABB2BF">;</span></span>
|
|
3502
3513
|
<span class="line"><span style="color:#ABB2BF">}</span></span></code></pre>
|
|
3503
3514
|
<h5 id="disconnect">disconnect()</h5>
|
|
3504
3515
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#61AFEF">disconnect</span><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">Promise</span><span style="color:#56B6C2"><</span><span style="color:#C678DD">void</span><span style="color:#56B6C2">></span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
3505
|
-
<h6 id="returns-
|
|
3516
|
+
<h6 id="returns-115">Returns</h6>
|
|
3506
3517
|
<p><code>Promise</code><<code>void</code>></p>
|
|
3507
3518
|
<h5 id="dispose-1">dispose()</h5>
|
|
3508
3519
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#61AFEF">dispose</span><span style="color:#ABB2BF">(): </span><span style="color:#C678DD">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
3509
|
-
<h6 id="returns-
|
|
3520
|
+
<h6 id="returns-116">Returns</h6>
|
|
3510
3521
|
<p><code>void</code></p>
|
|
3511
3522
|
<hr>
|
|
3512
3523
|
<p><a id="preflightworkerepochstorage"></a></p>
|
|
@@ -3528,7 +3539,7 @@ filters (<code>where()</code>, or nested <code>or()</code>/<code>and()</code>).
|
|
|
3528
3539
|
|
|
3529
3540
|
|
|
3530
3541
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>storage</code></td><td align="left"><code>EpochStorage</code></td></tr></tbody></table></div>
|
|
3531
|
-
<h4 id="returns-
|
|
3542
|
+
<h4 id="returns-117">Returns</h4>
|
|
3532
3543
|
<p><code>void</code></p>
|
|
3533
3544
|
<hr>
|
|
3534
3545
|
<p><a id="query"></a></p>
|
|
@@ -3555,7 +3566,7 @@ Mirrors <code>pyric/firestore</code>’s <code>query(source, ...constraints)</co
|
|
|
3555
3566
|
|
|
3556
3567
|
|
|
3557
3568
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>source</code></td><td align="left"><a href="#collrefhandle"><code>CollRefHandle</code></a> | <a href="#queryhandle"><code>QueryHandle</code></a></td></tr><tr><td align="left">…<code>constraints</code></td><td align="left"><code>QueryConstraintHandle</code>[]</td></tr></tbody></table></div>
|
|
3558
|
-
<h4 id="returns-
|
|
3569
|
+
<h4 id="returns-118">Returns</h4>
|
|
3559
3570
|
<p><a href="#queryhandle"><code>QueryHandle</code></a></p>
|
|
3560
3571
|
<hr>
|
|
3561
3572
|
<p><a id="readpyricruntimemanifest"></a></p>
|
|
@@ -3577,7 +3588,7 @@ Mirrors <code>pyric/firestore</code>’s <code>query(source, ...constraints)</co
|
|
|
3577
3588
|
|
|
3578
3589
|
|
|
3579
3590
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>documentLike?</code></td><td align="left"><code>RuntimeDocument</code></td></tr></tbody></table></div>
|
|
3580
|
-
<h4 id="returns-
|
|
3591
|
+
<h4 id="returns-119">Returns</h4>
|
|
3581
3592
|
<p><a href="#pyricruntimemanifest"><code>PyricRuntimeManifest</code></a></p>
|
|
3582
3593
|
<hr>
|
|
3583
3594
|
<p><a id="ref-3"></a></p>
|
|
@@ -3606,7 +3617,7 @@ Mirrors <code>pyric/firestore</code>’s <code>query(source, ...constraints)</co
|
|
|
3606
3617
|
|
|
3607
3618
|
|
|
3608
3619
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>parent</code></td><td align="left">| <a href="#clientfirebasestorage"><code>ClientFirebaseStorage</code></a> | <a href="#clientstoragereference"><code>ClientStorageReference</code></a></td></tr><tr><td align="left"><code>path?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
3609
|
-
<h4 id="returns-
|
|
3620
|
+
<h4 id="returns-120">Returns</h4>
|
|
3610
3621
|
<p><a href="#clientstoragereference"><code>ClientStorageReference</code></a></p>
|
|
3611
3622
|
<hr>
|
|
3612
3623
|
<p><a id="relayworkerop"></a></p>
|
|
@@ -3634,7 +3645,7 @@ the worker’s <code>res.value</code>, rejects with an Error carrying <code>.cod
|
|
|
3634
3645
|
|
|
3635
3646
|
|
|
3636
3647
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>op</code></td><td align="left"><code>WorkerOpPayload</code></td></tr></tbody></table></div>
|
|
3637
|
-
<h4 id="returns-
|
|
3648
|
+
<h4 id="returns-121">Returns</h4>
|
|
3638
3649
|
<p><code>Promise</code><<code>unknown</code>></p>
|
|
3639
3650
|
<hr>
|
|
3640
3651
|
<p><a id="relayworkersub"></a></p>
|
|
@@ -3675,9 +3686,9 @@ history batches aren’t coalescible, so it needs bounded backpressure first
|
|
|
3675
3686
|
|
|
3676
3687
|
|
|
3677
3688
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>sub</code></td><td align="left"><code>WorkerSubPayload</code></td></tr><tr><td align="left"><code>onValue</code></td><td align="left">(<code>value</code>: <code>unknown</code>) => <code>void</code></td></tr></tbody></table></div>
|
|
3678
|
-
<h4 id="returns-
|
|
3689
|
+
<h4 id="returns-122">Returns</h4>
|
|
3679
3690
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
3680
|
-
<h5 id="returns-
|
|
3691
|
+
<h5 id="returns-123">Returns</h5>
|
|
3681
3692
|
<p><code>void</code></p>
|
|
3682
3693
|
<hr>
|
|
3683
3694
|
<p><a id="rememberworkerepoch"></a></p>
|
|
@@ -3703,7 +3714,7 @@ history batches aren’t coalescible, so it needs bounded backpressure first
|
|
|
3703
3714
|
|
|
3704
3715
|
|
|
3705
3716
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>epoch</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>storage</code></td><td align="left"><code>EpochStorage</code></td></tr></tbody></table></div>
|
|
3706
|
-
<h4 id="returns-
|
|
3717
|
+
<h4 id="returns-124">Returns</h4>
|
|
3707
3718
|
<p><code>void</code></p>
|
|
3708
3719
|
<hr>
|
|
3709
3720
|
<p><a id="resetall"></a></p>
|
|
@@ -3731,7 +3742,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3731
3742
|
|
|
3732
3743
|
|
|
3733
3744
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr></tbody></table></div>
|
|
3734
|
-
<h4 id="returns-
|
|
3745
|
+
<h4 id="returns-125">Returns</h4>
|
|
3735
3746
|
<p><code>Promise</code><{
|
|
3736
3747
|
<code>errors</code>: <code>string</code>[];
|
|
3737
3748
|
}></p>
|
|
@@ -3772,7 +3783,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3772
3783
|
|
|
3773
3784
|
|
|
3774
3785
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>targetEpoch</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left">{ <code>timeoutMs?</code>: <code>number</code>; }</td></tr><tr><td align="left"><code>options.timeoutMs?</code></td><td align="left"><code>number</code></td></tr></tbody></table></div>
|
|
3775
|
-
<h4 id="returns-
|
|
3786
|
+
<h4 id="returns-126">Returns</h4>
|
|
3776
3787
|
<p><code>Promise</code><<code>void</code>></p>
|
|
3777
3788
|
<hr>
|
|
3778
3789
|
<p><a id="rtdbchild"></a></p>
|
|
@@ -3797,13 +3808,13 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3797
3808
|
|
|
3798
3809
|
|
|
3799
3810
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>parent</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr><tr><td align="left"><code>path</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
3800
|
-
<h4 id="returns-
|
|
3811
|
+
<h4 id="returns-127">Returns</h4>
|
|
3801
3812
|
<p><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></p>
|
|
3802
3813
|
<hr>
|
|
3803
3814
|
<p><a id="rtdbconnectdatabaseemulator"></a></p>
|
|
3804
3815
|
<h3 id="rtdbconnectdatabaseemulator">rtdbConnectDatabaseEmulator()</h3>
|
|
3805
3816
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> rtdbConnectDatabaseEmulator</span><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
3806
|
-
<h4 id="returns-
|
|
3817
|
+
<h4 id="returns-128">Returns</h4>
|
|
3807
3818
|
<p><code>void</code></p>
|
|
3808
3819
|
<hr>
|
|
3809
3820
|
<p><a id="rtdbget"></a></p>
|
|
@@ -3824,7 +3835,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3824
3835
|
|
|
3825
3836
|
|
|
3826
3837
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left"><code>RtdbTarget</code></td></tr></tbody></table></div>
|
|
3827
|
-
<h4 id="returns-
|
|
3838
|
+
<h4 id="returns-129">Returns</h4>
|
|
3828
3839
|
<p><code>Promise</code><<a href="#rtdbdatasnapshot"><code>RtdbDataSnapshot</code></a>></p>
|
|
3829
3840
|
<hr>
|
|
3830
3841
|
<p><a id="rtdbgetdatabase"></a></p>
|
|
@@ -3849,7 +3860,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3849
3860
|
|
|
3850
3861
|
|
|
3851
3862
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>source?</code></td><td align="left"><code>string</code> | <a href="#clientdb"><code>ClientDb</code></a> | <code>URL</code></td></tr><tr><td align="left"><code>name?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
3852
|
-
<h4 id="returns-
|
|
3863
|
+
<h4 id="returns-130">Returns</h4>
|
|
3853
3864
|
<p><a href="#clientrtdb"><code>ClientRtdb</code></a></p>
|
|
3854
3865
|
<hr>
|
|
3855
3866
|
<p><a id="rtdbgooffline"></a></p>
|
|
@@ -3870,7 +3881,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3870
3881
|
|
|
3871
3882
|
|
|
3872
3883
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientrtdb"><code>ClientRtdb</code></a></td></tr></tbody></table></div>
|
|
3873
|
-
<h4 id="returns-
|
|
3884
|
+
<h4 id="returns-131">Returns</h4>
|
|
3874
3885
|
<p><code>void</code></p>
|
|
3875
3886
|
<hr>
|
|
3876
3887
|
<p><a id="rtdbgoonline"></a></p>
|
|
@@ -3891,7 +3902,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3891
3902
|
|
|
3892
3903
|
|
|
3893
3904
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientrtdb"><code>ClientRtdb</code></a></td></tr></tbody></table></div>
|
|
3894
|
-
<h4 id="returns-
|
|
3905
|
+
<h4 id="returns-132">Returns</h4>
|
|
3895
3906
|
<p><code>void</code></p>
|
|
3896
3907
|
<hr>
|
|
3897
3908
|
<p><a id="rtdboff"></a></p>
|
|
@@ -3923,7 +3934,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3923
3934
|
|
|
3924
3935
|
|
|
3925
3936
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left"><code>RtdbTarget</code></td></tr><tr><td align="left"><code>eventType?</code></td><td align="left"><code>RtdbEventType</code></td></tr><tr><td align="left"><code>callback?</code></td><td align="left"><code>object</code></td></tr></tbody></table></div>
|
|
3926
|
-
<h4 id="returns-
|
|
3937
|
+
<h4 id="returns-133">Returns</h4>
|
|
3927
3938
|
<p><code>void</code></p>
|
|
3928
3939
|
<hr>
|
|
3929
3940
|
<p><a id="rtdbonchildadded"></a></p>
|
|
@@ -3965,7 +3976,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
3965
3976
|
|
|
3966
3977
|
|
|
3967
3978
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left"><code>RtdbTarget</code></td></tr><tr><td align="left"><code>next</code></td><td align="left"><code>ChildCallback</code></td></tr><tr><td align="left"><code>cancel?</code></td><td align="left"><code>CancelOrOptions</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><code>ListenOptions</code></td></tr><tr><td align="left"><code>identity?</code></td><td align="left"><code>object</code></td></tr></tbody></table></div>
|
|
3968
|
-
<h4 id="returns-
|
|
3979
|
+
<h4 id="returns-134">Returns</h4>
|
|
3969
3980
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
3970
3981
|
<hr>
|
|
3971
3982
|
<p><a id="rtdbonchildchanged"></a></p>
|
|
@@ -4007,7 +4018,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4007
4018
|
|
|
4008
4019
|
|
|
4009
4020
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left"><code>RtdbTarget</code></td></tr><tr><td align="left"><code>next</code></td><td align="left"><code>ChildCallback</code></td></tr><tr><td align="left"><code>cancel?</code></td><td align="left"><code>CancelOrOptions</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><code>ListenOptions</code></td></tr><tr><td align="left"><code>identity?</code></td><td align="left"><code>object</code></td></tr></tbody></table></div>
|
|
4010
|
-
<h4 id="returns-
|
|
4021
|
+
<h4 id="returns-135">Returns</h4>
|
|
4011
4022
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
4012
4023
|
<hr>
|
|
4013
4024
|
<p><a id="rtdbonchildmoved"></a></p>
|
|
@@ -4049,7 +4060,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4049
4060
|
|
|
4050
4061
|
|
|
4051
4062
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left"><code>RtdbTarget</code></td></tr><tr><td align="left"><code>next</code></td><td align="left"><code>ChildCallback</code></td></tr><tr><td align="left"><code>cancel?</code></td><td align="left"><code>CancelOrOptions</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><code>ListenOptions</code></td></tr><tr><td align="left"><code>identity?</code></td><td align="left"><code>object</code></td></tr></tbody></table></div>
|
|
4052
|
-
<h4 id="returns-
|
|
4063
|
+
<h4 id="returns-136">Returns</h4>
|
|
4053
4064
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
4054
4065
|
<hr>
|
|
4055
4066
|
<p><a id="rtdbonchildremoved"></a></p>
|
|
@@ -4091,7 +4102,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4091
4102
|
|
|
4092
4103
|
|
|
4093
4104
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left"><code>RtdbTarget</code></td></tr><tr><td align="left"><code>next</code></td><td align="left"><code>ChildCallback</code></td></tr><tr><td align="left"><code>cancel?</code></td><td align="left"><code>CancelOrOptions</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><code>ListenOptions</code></td></tr><tr><td align="left"><code>identity?</code></td><td align="left"><code>object</code></td></tr></tbody></table></div>
|
|
4094
|
-
<h4 id="returns-
|
|
4105
|
+
<h4 id="returns-137">Returns</h4>
|
|
4095
4106
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
4096
4107
|
<hr>
|
|
4097
4108
|
<p><a id="rtdbondisconnect-1"></a></p>
|
|
@@ -4112,7 +4123,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4112
4123
|
|
|
4113
4124
|
|
|
4114
4125
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr></tbody></table></div>
|
|
4115
|
-
<h4 id="returns-
|
|
4126
|
+
<h4 id="returns-138">Returns</h4>
|
|
4116
4127
|
<p><a href="#rtdbondisconnect"><code>RtdbOnDisconnect</code></a></p>
|
|
4117
4128
|
<hr>
|
|
4118
4129
|
<p><a id="rtdbonvalue"></a></p>
|
|
@@ -4164,7 +4175,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4164
4175
|
|
|
4165
4176
|
|
|
4166
4177
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>target</code></td><td align="left"><code>RtdbTarget</code></td></tr><tr><td align="left"><code>next</code></td><td align="left">(<code>snap</code>: <a href="#rtdbdatasnapshot"><code>RtdbDataSnapshot</code></a>) => <code>void</code></td></tr><tr><td align="left"><code>cancelCallbackOrOptions?</code></td><td align="left">| (<code>err</code>: <code>unknown</code>) => <code>void</code> | { <code>onlyOnce?</code>: <code>boolean</code>; }</td></tr><tr><td align="left"><code>options?</code></td><td align="left">{ <code>onlyOnce?</code>: <code>boolean</code>; }</td></tr><tr><td align="left"><code>options.onlyOnce?</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><code>registryCallback?</code></td><td align="left"><code>object</code></td></tr></tbody></table></div>
|
|
4167
|
-
<h4 id="returns-
|
|
4178
|
+
<h4 id="returns-139">Returns</h4>
|
|
4168
4179
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
4169
4180
|
<hr>
|
|
4170
4181
|
<p><a id="rtdbpush"></a></p>
|
|
@@ -4189,7 +4200,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4189
4200
|
|
|
4190
4201
|
|
|
4191
4202
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr><tr><td align="left"><code>value?</code></td><td align="left"><code>unknown</code></td></tr></tbody></table></div>
|
|
4192
|
-
<h4 id="returns-
|
|
4203
|
+
<h4 id="returns-140">Returns</h4>
|
|
4193
4204
|
<p><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a> & <code>PromiseLike</code><<a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a>></p>
|
|
4194
4205
|
<hr>
|
|
4195
4206
|
<p><a id="rtdbref"></a></p>
|
|
@@ -4214,7 +4225,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4214
4225
|
|
|
4215
4226
|
|
|
4216
4227
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientrtdb"><code>ClientRtdb</code></a></td></tr><tr><td align="left"><code>path?</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
4217
|
-
<h4 id="returns-
|
|
4228
|
+
<h4 id="returns-141">Returns</h4>
|
|
4218
4229
|
<p><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></p>
|
|
4219
4230
|
<hr>
|
|
4220
4231
|
<p><a id="rtdbremove"></a></p>
|
|
@@ -4235,7 +4246,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4235
4246
|
|
|
4236
4247
|
|
|
4237
4248
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr></tbody></table></div>
|
|
4238
|
-
<h4 id="returns-
|
|
4249
|
+
<h4 id="returns-142">Returns</h4>
|
|
4239
4250
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4240
4251
|
<hr>
|
|
4241
4252
|
<p><a id="rtdbruntransaction"></a></p>
|
|
@@ -4280,7 +4291,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4280
4291
|
|
|
4281
4292
|
|
|
4282
4293
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr><tr><td align="left"><code>transactionUpdate</code></td><td align="left">(<code>current</code>: <code>T</code>) => <code>T</code></td></tr><tr><td align="left"><code>options?</code></td><td align="left"><code>RtdbTransactionOptions</code></td></tr></tbody></table></div>
|
|
4283
|
-
<h4 id="returns-
|
|
4294
|
+
<h4 id="returns-143">Returns</h4>
|
|
4284
4295
|
<p><code>Promise</code><<code>RtdbTransactionResult</code>></p>
|
|
4285
4296
|
<hr>
|
|
4286
4297
|
<p><a id="rtdbservertimestamp"></a></p>
|
|
@@ -4288,7 +4299,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4288
4299
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> rtdbServerTimestamp</span><span style="color:#ABB2BF">(): {</span></span>
|
|
4289
4300
|
<span class="line"><span style="color:#ABB2BF">};</span></span></code></pre>
|
|
4290
4301
|
<p>RTDB environment controls and server-value construction for served apps.</p>
|
|
4291
|
-
<h4 id="returns-
|
|
4302
|
+
<h4 id="returns-144">Returns</h4>
|
|
4292
4303
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#ABB2BF">{</span></span>
|
|
4293
4304
|
<span class="line"><span style="color:#ABB2BF">}</span></span></code></pre>
|
|
4294
4305
|
<hr>
|
|
@@ -4314,7 +4325,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4314
4325
|
|
|
4315
4326
|
|
|
4316
4327
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr><tr><td align="left"><code>value</code></td><td align="left"><code>unknown</code></td></tr></tbody></table></div>
|
|
4317
|
-
<h4 id="returns-
|
|
4328
|
+
<h4 id="returns-145">Returns</h4>
|
|
4318
4329
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4319
4330
|
<hr>
|
|
4320
4331
|
<p><a id="rtdbsetpriority"></a></p>
|
|
@@ -4339,7 +4350,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4339
4350
|
|
|
4340
4351
|
|
|
4341
4352
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr><tr><td align="left"><code>priority</code></td><td align="left"><code>string</code> | <code>number</code></td></tr></tbody></table></div>
|
|
4342
|
-
<h4 id="returns-
|
|
4353
|
+
<h4 id="returns-146">Returns</h4>
|
|
4343
4354
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4344
4355
|
<hr>
|
|
4345
4356
|
<p><a id="rtdbsetwithpriority"></a></p>
|
|
@@ -4371,7 +4382,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4371
4382
|
|
|
4372
4383
|
|
|
4373
4384
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr><tr><td align="left"><code>value</code></td><td align="left"><code>unknown</code></td></tr><tr><td align="left"><code>priority</code></td><td align="left"><code>string</code> | <code>number</code></td></tr></tbody></table></div>
|
|
4374
|
-
<h4 id="returns-
|
|
4385
|
+
<h4 id="returns-147">Returns</h4>
|
|
4375
4386
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4376
4387
|
<hr>
|
|
4377
4388
|
<p><a id="rtdbupdate"></a></p>
|
|
@@ -4396,7 +4407,7 @@ counterpart of calling <code>sandbox.resetAll()</code> on an in-process sandbox.
|
|
|
4396
4407
|
|
|
4397
4408
|
|
|
4398
4409
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#rtdbrefhandle"><code>RtdbRefHandle</code></a></td></tr><tr><td align="left"><code>values</code></td><td align="left"><code>Record</code><<code>string</code>, <code>unknown</code>></td></tr></tbody></table></div>
|
|
4399
|
-
<h4 id="returns-
|
|
4410
|
+
<h4 id="returns-148">Returns</h4>
|
|
4400
4411
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4401
4412
|
<hr>
|
|
4402
4413
|
<p><a id="runtransaction"></a></p>
|
|
@@ -4455,7 +4466,7 @@ on conflict rather than surfacing the error immediately.</p>
|
|
|
4455
4466
|
|
|
4456
4467
|
|
|
4457
4468
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>updateFn</code></td><td align="left">(<code>txn</code>: <a href="#clienttransaction"><code>ClientTransaction</code></a>) => <code>R</code> | <code>Promise</code><<code>R</code>></td></tr></tbody></table></div>
|
|
4458
|
-
<h4 id="returns-
|
|
4469
|
+
<h4 id="returns-149">Returns</h4>
|
|
4459
4470
|
<p><code>Promise</code><<code>R</code>></p>
|
|
4460
4471
|
<hr>
|
|
4461
4472
|
<p><a id="saveworkerbranch"></a></p>
|
|
@@ -4481,13 +4492,13 @@ on conflict rather than surfacing the error immediately.</p>
|
|
|
4481
4492
|
|
|
4482
4493
|
|
|
4483
4494
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>name</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
4484
|
-
<h4 id="returns-
|
|
4495
|
+
<h4 id="returns-150">Returns</h4>
|
|
4485
4496
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4486
4497
|
<hr>
|
|
4487
4498
|
<p><a id="servertimestamp"></a></p>
|
|
4488
4499
|
<h3 id="servertimestamp">serverTimestamp()</h3>
|
|
4489
4500
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> serverTimestamp</span><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">SentinelMarker</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
4490
|
-
<h4 id="returns-
|
|
4501
|
+
<h4 id="returns-151">Returns</h4>
|
|
4491
4502
|
<p><code>SentinelMarker</code></p>
|
|
4492
4503
|
<hr>
|
|
4493
4504
|
<p><a id="setdatabaserules"></a></p>
|
|
@@ -4515,7 +4526,7 @@ on conflict rather than surfacing the error immediately.</p>
|
|
|
4515
4526
|
|
|
4516
4527
|
|
|
4517
4528
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a> | <a href="#clientrtdb"><code>ClientRtdb</code></a></td></tr><tr><td align="left"><code>source</code></td><td align="left"><code>unknown</code></td></tr></tbody></table></div>
|
|
4518
|
-
<h4 id="returns-
|
|
4529
|
+
<h4 id="returns-152">Returns</h4>
|
|
4519
4530
|
<p><code>Promise</code><{
|
|
4520
4531
|
<code>messages</code>: <code>unknown</code>[];
|
|
4521
4532
|
<code>ok</code>: <code>boolean</code>;
|
|
@@ -4561,7 +4572,7 @@ on conflict rather than surfacing the error immediately.</p>
|
|
|
4561
4572
|
|
|
4562
4573
|
|
|
4563
4574
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#docrefhandle"><code>DocRefHandle</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><code>Record</code><<code>string</code>, <code>unknown</code>></td></tr><tr><td align="left"><code>options?</code></td><td align="left">{ <code>merge?</code>: <code>boolean</code>; <code>mergeFields?</code>: <code>string</code>[]; }</td></tr><tr><td align="left"><code>options.merge?</code></td><td align="left"><code>boolean</code></td></tr><tr><td align="left"><code>options.mergeFields?</code></td><td align="left"><code>string</code>[]</td></tr></tbody></table></div>
|
|
4564
|
-
<h4 id="returns-
|
|
4575
|
+
<h4 id="returns-153">Returns</h4>
|
|
4565
4576
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4566
4577
|
<hr>
|
|
4567
4578
|
<p><a id="setfirestorerules"></a></p>
|
|
@@ -4590,7 +4601,7 @@ on conflict rather than surfacing the error immediately.</p>
|
|
|
4590
4601
|
|
|
4591
4602
|
|
|
4592
4603
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>source</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
4593
|
-
<h4 id="returns-
|
|
4604
|
+
<h4 id="returns-154">Returns</h4>
|
|
4594
4605
|
<p><code>Promise</code><{
|
|
4595
4606
|
<code>messages</code>: <code>unknown</code>[];
|
|
4596
4607
|
<code>ok</code>: <code>boolean</code>;
|
|
@@ -4601,12 +4612,16 @@ on conflict rather than surfacing the error immediately.</p>
|
|
|
4601
4612
|
<h3 id="setlens">setLens()</h3>
|
|
4602
4613
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> setLens</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">lens</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">AuthLens</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
4603
4614
|
<p>Set the default auth lens applied to subsequent Firestore DATA ops from this
|
|
4604
|
-
client (Pyric Studio). Pass <code>{ mode: 'as', uid }</code> to read/write AS a user
|
|
4615
|
+
client (Pyric Studio & Runtime Chip). Pass <code>{ mode: 'as', uid }</code> to read/write AS a user
|
|
4605
4616
|
(rules apply), <code>{ mode: 'admin' }</code> for the admin lens, or
|
|
4606
4617
|
<code>{ mode: 'app-session' }</code> / <code>undefined</code> to revert to the app’s own session.</p>
|
|
4607
4618
|
<p>The lens is process-wide for this client module (one served page = one
|
|
4608
4619
|
worker port), mirroring how Studio drives a single active identity at a time.
|
|
4609
4620
|
Auth ops are unaffected — they always operate the real session.</p>
|
|
4621
|
+
<p>Persists active admin and impersonation lenses to sessionStorage under
|
|
4622
|
+
AUTH_LENS_STORAGE_KEY, and removes the key when cleared or reverted to the
|
|
4623
|
+
app session.
|
|
4624
|
+
Notifies all registered subscribeLens listeners.</p>
|
|
4610
4625
|
<h4 id="parameters-122">Parameters</h4>
|
|
4611
4626
|
<div class="table-scroll">
|
|
4612
4627
|
|
|
@@ -4622,7 +4637,7 @@ Auth ops are unaffected — they always operate the real session.</p>
|
|
|
4622
4637
|
|
|
4623
4638
|
|
|
4624
4639
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>lens</code></td><td align="left"><a href="/docs/pyric-sandbox-reference-api/#authlens-2"><code>AuthLens</code></a></td></tr></tbody></table></div>
|
|
4625
|
-
<h4 id="returns-
|
|
4640
|
+
<h4 id="returns-155">Returns</h4>
|
|
4626
4641
|
<p><code>void</code></p>
|
|
4627
4642
|
<hr>
|
|
4628
4643
|
<p><a id="setopissuer"></a></p>
|
|
@@ -4644,7 +4659,7 @@ Auth ops are unaffected — they always operate the real session.</p>
|
|
|
4644
4659
|
|
|
4645
4660
|
|
|
4646
4661
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>source</code></td><td align="left"><code>"studio"</code></td></tr></tbody></table></div>
|
|
4647
|
-
<h4 id="returns-
|
|
4662
|
+
<h4 id="returns-156">Returns</h4>
|
|
4648
4663
|
<p><code>void</code></p>
|
|
4649
4664
|
<hr>
|
|
4650
4665
|
<p><a id="setpersistence"></a></p>
|
|
@@ -4673,7 +4688,7 @@ tab’s session uid is stored for reload restore.</p>
|
|
|
4673
4688
|
|
|
4674
4689
|
|
|
4675
4690
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr><tr><td align="left"><code>persistence</code></td><td align="left"><code>ClientPersistence</code></td></tr></tbody></table></div>
|
|
4676
|
-
<h4 id="returns-
|
|
4691
|
+
<h4 id="returns-157">Returns</h4>
|
|
4677
4692
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4678
4693
|
<hr>
|
|
4679
4694
|
<p><a id="setproviderconfig"></a></p>
|
|
@@ -4705,7 +4720,7 @@ tab’s session uid is stored for reload restore.</p>
|
|
|
4705
4720
|
|
|
4706
4721
|
|
|
4707
4722
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr><tr><td align="left"><code>providerId</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>enabled</code></td><td align="left"><code>boolean</code></td></tr></tbody></table></div>
|
|
4708
|
-
<h4 id="returns-
|
|
4723
|
+
<h4 id="returns-158">Returns</h4>
|
|
4709
4724
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4710
4725
|
<hr>
|
|
4711
4726
|
<p><a id="setrules"></a></p>
|
|
@@ -4735,7 +4750,7 @@ if the new rules deny them.</p>
|
|
|
4735
4750
|
|
|
4736
4751
|
|
|
4737
4752
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>source</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
4738
|
-
<h4 id="returns-
|
|
4753
|
+
<h4 id="returns-159">Returns</h4>
|
|
4739
4754
|
<p><code>Promise</code><{
|
|
4740
4755
|
<code>warnings</code>: <code>unknown</code>[];
|
|
4741
4756
|
}></p>
|
|
@@ -4758,7 +4773,7 @@ if the new rules deny them.</p>
|
|
|
4758
4773
|
|
|
4759
4774
|
|
|
4760
4775
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr></tbody></table></div>
|
|
4761
|
-
<h4 id="returns-
|
|
4776
|
+
<h4 id="returns-160">Returns</h4>
|
|
4762
4777
|
<p><code>Promise</code><<a href="#clientusercredential"><code>ClientUserCredential</code></a>></p>
|
|
4763
4778
|
<hr>
|
|
4764
4779
|
<p><a id="signinwithemailandpassword"></a></p>
|
|
@@ -4790,7 +4805,7 @@ if the new rules deny them.</p>
|
|
|
4790
4805
|
|
|
4791
4806
|
|
|
4792
4807
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr><tr><td align="left"><code>email</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>password</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
4793
|
-
<h4 id="returns-
|
|
4808
|
+
<h4 id="returns-161">Returns</h4>
|
|
4794
4809
|
<p><code>Promise</code><<a href="#clientusercredential"><code>ClientUserCredential</code></a>></p>
|
|
4795
4810
|
<hr>
|
|
4796
4811
|
<p><a id="signout"></a></p>
|
|
@@ -4811,7 +4826,7 @@ if the new rules deny them.</p>
|
|
|
4811
4826
|
|
|
4812
4827
|
|
|
4813
4828
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>auth</code></td><td align="left"><a href="#clientauth"><code>ClientAuth</code></a></td></tr></tbody></table></div>
|
|
4814
|
-
<h4 id="returns-
|
|
4829
|
+
<h4 id="returns-162">Returns</h4>
|
|
4815
4830
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4816
4831
|
<hr>
|
|
4817
4832
|
<p><a id="startafter"></a></p>
|
|
@@ -4832,7 +4847,7 @@ if the new rules deny them.</p>
|
|
|
4832
4847
|
|
|
4833
4848
|
|
|
4834
4849
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left">…<code>values</code></td><td align="left"><code>unknown</code>[]</td></tr></tbody></table></div>
|
|
4835
|
-
<h4 id="returns-
|
|
4850
|
+
<h4 id="returns-163">Returns</h4>
|
|
4836
4851
|
<p><code>QueryConstraintHandle</code></p>
|
|
4837
4852
|
<hr>
|
|
4838
4853
|
<p><a id="startat"></a></p>
|
|
@@ -4853,7 +4868,7 @@ if the new rules deny them.</p>
|
|
|
4853
4868
|
|
|
4854
4869
|
|
|
4855
4870
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left">…<code>values</code></td><td align="left"><code>unknown</code>[]</td></tr></tbody></table></div>
|
|
4856
|
-
<h4 id="returns-
|
|
4871
|
+
<h4 id="returns-164">Returns</h4>
|
|
4857
4872
|
<p><code>QueryConstraintHandle</code></p>
|
|
4858
4873
|
<hr>
|
|
4859
4874
|
<p><a id="startpresence"></a></p>
|
|
@@ -4876,7 +4891,7 @@ if the new rules deny them.</p>
|
|
|
4876
4891
|
|
|
4877
4892
|
|
|
4878
4893
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>opts</code></td><td align="left"><code>StartPresenceOptions</code></td></tr></tbody></table></div>
|
|
4879
|
-
<h4 id="returns-
|
|
4894
|
+
<h4 id="returns-165">Returns</h4>
|
|
4880
4895
|
<p><a href="#presencesession"><code>PresenceSession</code></a></p>
|
|
4881
4896
|
<hr>
|
|
4882
4897
|
<p><a id="subscribeevents"></a></p>
|
|
@@ -4908,15 +4923,40 @@ backlog.</p>
|
|
|
4908
4923
|
|
|
4909
4924
|
|
|
4910
4925
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>callback</code></td><td align="left">(<code>events</code>: readonly <a href="/docs/pyric-sandbox-reference-api/#sandboxevent"><code>SandboxEvent</code></a>[]) => <code>void</code></td></tr></tbody></table></div>
|
|
4911
|
-
<h4 id="returns-
|
|
4926
|
+
<h4 id="returns-166">Returns</h4>
|
|
4912
4927
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
4913
4928
|
<hr>
|
|
4929
|
+
<p><a id="subscribelens"></a></p>
|
|
4930
|
+
<h3 id="subscribelens">subscribeLens()</h3>
|
|
4931
|
+
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> subscribeLens</span><span style="color:#ABB2BF">(</span><span style="color:#61AFEF">listener</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">lens</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">AuthLens</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">): () </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
4932
|
+
<p>Register a listener for auth lens mutations.
|
|
4933
|
+
Returns an unsubscribe function that removes the listener.</p>
|
|
4934
|
+
<h4 id="parameters-134">Parameters</h4>
|
|
4935
|
+
<div class="table-scroll">
|
|
4936
|
+
|
|
4937
|
+
|
|
4938
|
+
|
|
4939
|
+
|
|
4940
|
+
|
|
4941
|
+
|
|
4942
|
+
|
|
4943
|
+
|
|
4944
|
+
|
|
4945
|
+
|
|
4946
|
+
|
|
4947
|
+
|
|
4948
|
+
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>listener</code></td><td align="left">(<code>lens</code>: <a href="/docs/pyric-sandbox-reference-api/#authlens-2"><code>AuthLens</code></a>) => <code>void</code></td></tr></tbody></table></div>
|
|
4949
|
+
<h4 id="returns-167">Returns</h4>
|
|
4950
|
+
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#ABB2BF">(): </span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
4951
|
+
<h5 id="returns-168">Returns</h5>
|
|
4952
|
+
<p><code>void</code></p>
|
|
4953
|
+
<hr>
|
|
4914
4954
|
<p><a id="subscribepresence"></a></p>
|
|
4915
4955
|
<h3 id="subscribepresence">subscribePresence()</h3>
|
|
4916
4956
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> subscribePresence</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">db</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ClientDb</span><span style="color:#ABB2BF">, </span><span style="color:#61AFEF">callback</span><span style="color:#ABB2BF">: (</span><span style="color:#E06C75;font-style:italic">snapshot</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">PresenceSnapshot</span><span style="color:#ABB2BF">) </span><span style="color:#C678DD">=></span><span style="color:#E5C07B"> void</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Unsubscribe</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
4917
4957
|
<p>Subscribe to the worker’s authoritative presence snapshot. The callback
|
|
4918
4958
|
fires immediately with the current snapshot, then on every change.</p>
|
|
4919
|
-
<h4 id="parameters-
|
|
4959
|
+
<h4 id="parameters-135">Parameters</h4>
|
|
4920
4960
|
<div class="table-scroll">
|
|
4921
4961
|
|
|
4922
4962
|
|
|
@@ -4935,14 +4975,14 @@ fires immediately with the current snapshot, then on every change.</p>
|
|
|
4935
4975
|
|
|
4936
4976
|
|
|
4937
4977
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>callback</code></td><td align="left">(<code>snapshot</code>: <a href="#presencesnapshot"><code>PresenceSnapshot</code></a>) => <code>void</code></td></tr></tbody></table></div>
|
|
4938
|
-
<h4 id="returns-
|
|
4978
|
+
<h4 id="returns-169">Returns</h4>
|
|
4939
4979
|
<p><a href="#unsubscribe"><code>Unsubscribe</code></a></p>
|
|
4940
4980
|
<hr>
|
|
4941
4981
|
<p><a id="sum"></a></p>
|
|
4942
4982
|
<h3 id="sum">sum()</h3>
|
|
4943
4983
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> sum</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">field</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">AggregateFieldDescriptor</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
4944
4984
|
<p>Factory: sum-of-<code>field</code> aggregate. Mirrors <code>pyric/firestore</code>’s <code>sum()</code>.</p>
|
|
4945
|
-
<h4 id="parameters-
|
|
4985
|
+
<h4 id="parameters-136">Parameters</h4>
|
|
4946
4986
|
<div class="table-scroll">
|
|
4947
4987
|
|
|
4948
4988
|
|
|
@@ -4957,14 +4997,14 @@ fires immediately with the current snapshot, then on every change.</p>
|
|
|
4957
4997
|
|
|
4958
4998
|
|
|
4959
4999
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>field</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
4960
|
-
<h4 id="returns-
|
|
5000
|
+
<h4 id="returns-170">Returns</h4>
|
|
4961
5001
|
<p><code>AggregateFieldDescriptor</code></p>
|
|
4962
5002
|
<hr>
|
|
4963
5003
|
<p><a id="switchworkerbranch"></a></p>
|
|
4964
5004
|
<h3 id="switchworkerbranch">switchWorkerBranch()</h3>
|
|
4965
5005
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> switchWorkerBranch</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">db</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ClientDb</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75;font-style:italic">name</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF"><</span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">>;</span></span></code></pre>
|
|
4966
5006
|
<p>Phase 3 (clobber): switch the live sandbox to a named branch’s state.</p>
|
|
4967
|
-
<h4 id="parameters-
|
|
5007
|
+
<h4 id="parameters-137">Parameters</h4>
|
|
4968
5008
|
<div class="table-scroll">
|
|
4969
5009
|
|
|
4970
5010
|
|
|
@@ -4983,13 +5023,13 @@ fires immediately with the current snapshot, then on every change.</p>
|
|
|
4983
5023
|
|
|
4984
5024
|
|
|
4985
5025
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr><tr><td align="left"><code>name</code></td><td align="left"><code>string</code></td></tr></tbody></table></div>
|
|
4986
|
-
<h4 id="returns-
|
|
5026
|
+
<h4 id="returns-171">Returns</h4>
|
|
4987
5027
|
<p><code>Promise</code><<code>void</code>></p>
|
|
4988
5028
|
<hr>
|
|
4989
5029
|
<p><a id="updatedoc"></a></p>
|
|
4990
5030
|
<h3 id="updatedoc">updateDoc()</h3>
|
|
4991
5031
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> updateDoc</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">ref</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">DocRefHandle</span><span style="color:#ABB2BF">, </span><span style="color:#E06C75;font-style:italic">data</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">Record</span><span style="color:#ABB2BF"><</span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">, </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">>): </span><span style="color:#E5C07B">Promise</span><span style="color:#ABB2BF"><</span><span style="color:#E5C07B">void</span><span style="color:#ABB2BF">>;</span></span></code></pre>
|
|
4992
|
-
<h4 id="parameters-
|
|
5032
|
+
<h4 id="parameters-138">Parameters</h4>
|
|
4993
5033
|
<div class="table-scroll">
|
|
4994
5034
|
|
|
4995
5035
|
|
|
@@ -5008,7 +5048,7 @@ fires immediately with the current snapshot, then on every change.</p>
|
|
|
5008
5048
|
|
|
5009
5049
|
|
|
5010
5050
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>ref</code></td><td align="left"><a href="#docrefhandle"><code>DocRefHandle</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><code>Record</code><<code>string</code>, <code>unknown</code>></td></tr></tbody></table></div>
|
|
5011
|
-
<h4 id="returns-
|
|
5051
|
+
<h4 id="returns-172">Returns</h4>
|
|
5012
5052
|
<p><code>Promise</code><<code>void</code>></p>
|
|
5013
5053
|
<hr>
|
|
5014
5054
|
<p><a id="uploadbytes"></a></p>
|
|
@@ -5022,7 +5062,7 @@ fires immediately with the current snapshot, then on every change.</p>
|
|
|
5022
5062
|
<span class="line"><span style="color:#ABB2BF">}>;</span></span></code></pre>
|
|
5023
5063
|
<p>Upload bytes at the reference’s path (replaces existing content).
|
|
5024
5064
|
Mirrors <code>pyric/storage</code>’s <code>uploadBytes</code> result shape.</p>
|
|
5025
|
-
<h4 id="parameters-
|
|
5065
|
+
<h4 id="parameters-139">Parameters</h4>
|
|
5026
5066
|
<div class="table-scroll">
|
|
5027
5067
|
|
|
5028
5068
|
|
|
@@ -5045,7 +5085,7 @@ Mirrors <code>pyric/storage</code>’s <code>uploadBytes</code> result shape.</p
|
|
|
5045
5085
|
|
|
5046
5086
|
|
|
5047
5087
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#clientstoragereference"><code>ClientStorageReference</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><code>ArrayBuffer</code> | <code>Uint8Array</code><<code>ArrayBufferLike</code>> | <code>Blob</code></td></tr><tr><td align="left"><code>metadata?</code></td><td align="left"><a href="#clientsettablemetadata"><code>ClientSettableMetadata</code></a></td></tr></tbody></table></div>
|
|
5048
|
-
<h4 id="returns-
|
|
5088
|
+
<h4 id="returns-173">Returns</h4>
|
|
5049
5089
|
<p><code>Promise</code><{
|
|
5050
5090
|
<code>metadata</code>: <a href="/docs/pyric-storage-reference-api/#fullmetadata"><code>FullMetadata</code></a>;
|
|
5051
5091
|
<code>ref</code>: <a href="#clientstoragereference"><code>ClientStorageReference</code></a>;
|
|
@@ -5057,7 +5097,7 @@ Mirrors <code>pyric/storage</code>’s <code>uploadBytes</code> result shape.</p
|
|
|
5057
5097
|
<span class="line"><span style="color:#E06C75;font-style:italic"> reference</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ClientStorageReference</span><span style="color:#ABB2BF">,</span></span>
|
|
5058
5098
|
<span class="line"><span style="color:#E06C75;font-style:italic"> data</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ArrayBuffer</span><span style="color:#ABB2BF"> | </span><span style="color:#E5C07B">Uint8Array</span><span style="color:#ABB2BF"><</span><span style="color:#E5C07B">ArrayBufferLike</span><span style="color:#ABB2BF">> | </span><span style="color:#E5C07B">Blob</span><span style="color:#ABB2BF">,</span></span>
|
|
5059
5099
|
<span class="line"><span style="color:#E06C75;font-style:italic"> metadata</span><span style="color:#C678DD">?</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ClientSettableMetadata</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">ClientUploadTask</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
5060
|
-
<h4 id="parameters-
|
|
5100
|
+
<h4 id="parameters-140">Parameters</h4>
|
|
5061
5101
|
<div class="table-scroll">
|
|
5062
5102
|
|
|
5063
5103
|
|
|
@@ -5080,7 +5120,7 @@ Mirrors <code>pyric/storage</code>’s <code>uploadBytes</code> result shape.</p
|
|
|
5080
5120
|
|
|
5081
5121
|
|
|
5082
5122
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#clientstoragereference"><code>ClientStorageReference</code></a></td></tr><tr><td align="left"><code>data</code></td><td align="left"><code>ArrayBuffer</code> | <code>Uint8Array</code><<code>ArrayBufferLike</code>> | <code>Blob</code></td></tr><tr><td align="left"><code>metadata?</code></td><td align="left"><a href="#clientsettablemetadata"><code>ClientSettableMetadata</code></a></td></tr></tbody></table></div>
|
|
5083
|
-
<h4 id="returns-
|
|
5123
|
+
<h4 id="returns-174">Returns</h4>
|
|
5084
5124
|
<p><a href="#clientuploadtask"><code>ClientUploadTask</code></a></p>
|
|
5085
5125
|
<hr>
|
|
5086
5126
|
<p><a id="uploadstring"></a></p>
|
|
@@ -5095,7 +5135,7 @@ Mirrors <code>pyric/storage</code>’s <code>uploadBytes</code> result shape.</p
|
|
|
5095
5135
|
<span class="line"><span style="color:#ABB2BF">}>;</span></span></code></pre>
|
|
5096
5136
|
<p>Upload string payload at the reference’s path.
|
|
5097
5137
|
Mirrors <code>pyric/storage</code>’s <code>uploadString</code> result shape.</p>
|
|
5098
|
-
<h4 id="parameters-
|
|
5138
|
+
<h4 id="parameters-141">Parameters</h4>
|
|
5099
5139
|
<div class="table-scroll">
|
|
5100
5140
|
|
|
5101
5141
|
|
|
@@ -5122,7 +5162,7 @@ Mirrors <code>pyric/storage</code>’s <code>uploadString</code> result shape.</
|
|
|
5122
5162
|
|
|
5123
5163
|
|
|
5124
5164
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>reference</code></td><td align="left"><a href="#clientstoragereference"><code>ClientStorageReference</code></a></td></tr><tr><td align="left"><code>value</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>format?</code></td><td align="left"><a href="/docs/pyric-storage-reference-api/#stringformat"><code>StringFormat</code></a></td></tr><tr><td align="left"><code>metadata?</code></td><td align="left"><a href="#clientsettablemetadata"><code>ClientSettableMetadata</code></a></td></tr></tbody></table></div>
|
|
5125
|
-
<h4 id="returns-
|
|
5165
|
+
<h4 id="returns-175">Returns</h4>
|
|
5126
5166
|
<p><code>Promise</code><{
|
|
5127
5167
|
<code>metadata</code>: <a href="/docs/pyric-storage-reference-api/#fullmetadata"><code>FullMetadata</code></a>;
|
|
5128
5168
|
<code>ref</code>: <a href="#clientstoragereference"><code>ClientStorageReference</code></a>;
|
|
@@ -5134,7 +5174,7 @@ Mirrors <code>pyric/storage</code>’s <code>uploadString</code> result shape.</
|
|
|
5134
5174
|
<span class="line"><span style="color:#E06C75;font-style:italic"> field</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">,</span></span>
|
|
5135
5175
|
<span class="line"><span style="color:#E06C75;font-style:italic"> op</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">string</span><span style="color:#ABB2BF">,</span></span>
|
|
5136
5176
|
<span class="line"><span style="color:#E06C75;font-style:italic"> value</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">unknown</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">QueryConstraintHandle</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
5137
|
-
<h4 id="parameters-
|
|
5177
|
+
<h4 id="parameters-142">Parameters</h4>
|
|
5138
5178
|
<div class="table-scroll">
|
|
5139
5179
|
|
|
5140
5180
|
|
|
@@ -5157,7 +5197,7 @@ Mirrors <code>pyric/storage</code>’s <code>uploadString</code> result shape.</
|
|
|
5157
5197
|
|
|
5158
5198
|
|
|
5159
5199
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>field</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>op</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>value</code></td><td align="left"><code>unknown</code></td></tr></tbody></table></div>
|
|
5160
|
-
<h4 id="returns-
|
|
5200
|
+
<h4 id="returns-176">Returns</h4>
|
|
5161
5201
|
<p><code>QueryConstraintHandle</code></p>
|
|
5162
5202
|
<hr>
|
|
5163
5203
|
<p><a id="workernameforepoch"></a></p>
|
|
@@ -5169,7 +5209,7 @@ still have the legacy <code>pyric-shared-worker</code> alive. Seed the first ser
|
|
|
5169
5209
|
epoch before connecting so a new client never attaches to that incompatible
|
|
5170
5210
|
worker. Later releases keep using the stored generation until replacement
|
|
5171
5211
|
is explicitly committed.</p>
|
|
5172
|
-
<h4 id="parameters-
|
|
5212
|
+
<h4 id="parameters-143">Parameters</h4>
|
|
5173
5213
|
<div class="table-scroll">
|
|
5174
5214
|
|
|
5175
5215
|
|
|
@@ -5188,13 +5228,13 @@ is explicitly committed.</p>
|
|
|
5188
5228
|
|
|
5189
5229
|
|
|
5190
5230
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>servedEpoch</code></td><td align="left"><code>string</code></td></tr><tr><td align="left"><code>storage</code></td><td align="left"><code>EpochStorage</code></td></tr></tbody></table></div>
|
|
5191
|
-
<h4 id="returns-
|
|
5231
|
+
<h4 id="returns-177">Returns</h4>
|
|
5192
5232
|
<p><code>string</code></p>
|
|
5193
5233
|
<hr>
|
|
5194
5234
|
<p><a id="writebatch"></a></p>
|
|
5195
5235
|
<h3 id="writebatch">writeBatch()</h3>
|
|
5196
5236
|
<pre class="astro-code one-dark-pro" style="background-color:#282c34;color:#abb2bf; overflow-x: auto;" tabindex="0" data-language="ts"><code><span class="line"><span style="color:#C678DD">function</span><span style="color:#61AFEF"> writeBatch</span><span style="color:#ABB2BF">(</span><span style="color:#E06C75;font-style:italic">db</span><span style="color:#ABB2BF">: </span><span style="color:#E5C07B">ClientDb</span><span style="color:#ABB2BF">): </span><span style="color:#E5C07B">ClientWriteBatch</span><span style="color:#ABB2BF">;</span></span></code></pre>
|
|
5197
|
-
<h4 id="parameters-
|
|
5237
|
+
<h4 id="parameters-144">Parameters</h4>
|
|
5198
5238
|
<div class="table-scroll">
|
|
5199
5239
|
|
|
5200
5240
|
|
|
@@ -5209,5 +5249,5 @@ is explicitly committed.</p>
|
|
|
5209
5249
|
|
|
5210
5250
|
|
|
5211
5251
|
<table><thead><tr><th align="left">Parameter</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>db</code></td><td align="left"><a href="#clientdb"><code>ClientDb</code></a></td></tr></tbody></table></div>
|
|
5212
|
-
<h4 id="returns-
|
|
5213
|
-
<p><a href="#clientwritebatch"><code>ClientWriteBatch</code></a></p> </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols" data-astro-cid-mw7aashj> <h2 class="doc-toc-heading" data-astro-cid-mw7aashj>Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter data-astro-cid-mw7aashj> <div class="api-symbol-groups" data-api-symbol-groups data-astro-cid-mw7aashj> <section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#classes" data-astro-cid-mw7aashj> Classes </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="rtdbondisconnect" data-astro-cid-mw7aashj> <a href="#rtdbondisconnect" data-astro-cid-mw7aashj>RtdbOnDisconnect</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#interfaces" data-astro-cid-mw7aashj> Interfaces </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="clientauth" data-astro-cid-mw7aashj> <a href="#clientauth" data-astro-cid-mw7aashj>ClientAuth</a> </li><li data-api-symbol="clientdb" data-astro-cid-mw7aashj> <a href="#clientdb" data-astro-cid-mw7aashj>ClientDb</a> </li><li data-api-symbol="clientdocsnapshot" data-astro-cid-mw7aashj> <a href="#clientdocsnapshot" data-astro-cid-mw7aashj>ClientDocSnapshot</a> </li><li data-api-symbol="clientfirebasestorage" data-astro-cid-mw7aashj> <a href="#clientfirebasestorage" data-astro-cid-mw7aashj>ClientFirebaseStorage</a> </li><li data-api-symbol="clientquerysnapshot" data-astro-cid-mw7aashj> <a href="#clientquerysnapshot" data-astro-cid-mw7aashj>ClientQuerySnapshot</a> </li><li data-api-symbol="clientrtdb" data-astro-cid-mw7aashj> <a href="#clientrtdb" data-astro-cid-mw7aashj>ClientRtdb</a> </li><li data-api-symbol="clientsettablemetadata" data-astro-cid-mw7aashj> <a href="#clientsettablemetadata" data-astro-cid-mw7aashj>ClientSettableMetadata</a> </li><li data-api-symbol="clientstoragereference" data-astro-cid-mw7aashj> <a href="#clientstoragereference" data-astro-cid-mw7aashj>ClientStorageReference</a> </li><li data-api-symbol="clienttransaction" data-astro-cid-mw7aashj> <a href="#clienttransaction" data-astro-cid-mw7aashj>ClientTransaction</a> </li><li data-api-symbol="clientuploadtask" data-astro-cid-mw7aashj> <a href="#clientuploadtask" data-astro-cid-mw7aashj>ClientUploadTask</a> </li><li data-api-symbol="clientuploadtasksnapshot" data-astro-cid-mw7aashj> <a href="#clientuploadtasksnapshot" data-astro-cid-mw7aashj>ClientUploadTaskSnapshot</a> </li><li data-api-symbol="clientuser" data-astro-cid-mw7aashj> <a href="#clientuser" data-astro-cid-mw7aashj>ClientUser</a> </li><li data-api-symbol="clientusercredential" data-astro-cid-mw7aashj> <a href="#clientusercredential" data-astro-cid-mw7aashj>ClientUserCredential</a> </li><li data-api-symbol="clientwritebatch" data-astro-cid-mw7aashj> <a href="#clientwritebatch" data-astro-cid-mw7aashj>ClientWriteBatch</a> </li><li data-api-symbol="collrefhandle" data-astro-cid-mw7aashj> <a href="#collrefhandle" data-astro-cid-mw7aashj>CollRefHandle</a> </li><li data-api-symbol="disconnectclientoptions" data-astro-cid-mw7aashj> <a href="#disconnectclientoptions" data-astro-cid-mw7aashj>DisconnectClientOptions</a> </li><li data-api-symbol="docrefhandle" data-astro-cid-mw7aashj> <a href="#docrefhandle" data-astro-cid-mw7aashj>DocRefHandle</a> </li><li data-api-symbol="presencesession" data-astro-cid-mw7aashj> <a href="#presencesession" data-astro-cid-mw7aashj>PresenceSession</a> </li><li data-api-symbol="presencesnapshot" data-astro-cid-mw7aashj> <a href="#presencesnapshot" data-astro-cid-mw7aashj>PresenceSnapshot</a> </li><li data-api-symbol="pyricruntimemanifest" data-astro-cid-mw7aashj> <a href="#pyricruntimemanifest" data-astro-cid-mw7aashj>PyricRuntimeManifest</a> </li><li data-api-symbol="queryhandle" data-astro-cid-mw7aashj> <a href="#queryhandle" data-astro-cid-mw7aashj>QueryHandle</a> </li><li data-api-symbol="resolvedidentity" data-astro-cid-mw7aashj> <a href="#resolvedidentity" data-astro-cid-mw7aashj>ResolvedIdentity</a> </li><li data-api-symbol="rtdbdatasnapshot" data-astro-cid-mw7aashj> <a href="#rtdbdatasnapshot" data-astro-cid-mw7aashj>RtdbDataSnapshot</a> </li><li data-api-symbol="rtdbrefhandle" data-astro-cid-mw7aashj> <a href="#rtdbrefhandle" data-astro-cid-mw7aashj>RtdbRefHandle</a> </li><li data-api-symbol="serializedidtokenresult" data-astro-cid-mw7aashj> <a href="#serializedidtokenresult" data-astro-cid-mw7aashj>SerializedIdTokenResult</a> </li><li data-api-symbol="serializeduser" data-astro-cid-mw7aashj> <a href="#serializeduser" data-astro-cid-mw7aashj>SerializedUser</a> </li><li data-api-symbol="serializedusercredential" data-astro-cid-mw7aashj> <a href="#serializedusercredential" data-astro-cid-mw7aashj>SerializedUserCredential</a> </li><li data-api-symbol="workerreplacement" data-astro-cid-mw7aashj> <a href="#workerreplacement" data-astro-cid-mw7aashj>WorkerReplacement</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#type-aliases" data-astro-cid-mw7aashj> Type Aliases </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="anyhandle" data-astro-cid-mw7aashj> <a href="#anyhandle" data-astro-cid-mw7aashj>AnyHandle</a> </li><li data-api-symbol="authpersistencemode" data-astro-cid-mw7aashj> <a href="#authpersistencemode" data-astro-cid-mw7aashj>AuthPersistenceMode</a> </li><li data-api-symbol="presenceclientkind" data-astro-cid-mw7aashj> <a href="#presenceclientkind" data-astro-cid-mw7aashj>PresenceClientKind</a> </li><li data-api-symbol="presencevisibility" data-astro-cid-mw7aashj> <a href="#presencevisibility" data-astro-cid-mw7aashj>PresenceVisibility</a> </li><li data-api-symbol="unsubscribe()" data-astro-cid-mw7aashj> <a href="#unsubscribe" data-astro-cid-mw7aashj>Unsubscribe()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#variables" data-astro-cid-mw7aashj> Variables </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="browserlocalpersistence" data-astro-cid-mw7aashj> <a href="#browserlocalpersistence" data-astro-cid-mw7aashj>browserLocalPersistence</a> </li><li data-api-symbol="browsersessionpersistence" data-astro-cid-mw7aashj> <a href="#browsersessionpersistence" data-astro-cid-mw7aashj>browserSessionPersistence</a> </li><li data-api-symbol="inmemorypersistence" data-astro-cid-mw7aashj> <a href="#inmemorypersistence" data-astro-cid-mw7aashj>inMemoryPersistence</a> </li><li data-api-symbol="presence_heartbeat_interval_ms" data-astro-cid-mw7aashj> <a href="#presence_heartbeat_interval_ms" data-astro-cid-mw7aashj>PRESENCE_HEARTBEAT_INTERVAL_MS</a> </li><li data-api-symbol="presence_stale_ms" data-astro-cid-mw7aashj> <a href="#presence_stale_ms" data-astro-cid-mw7aashj>PRESENCE_STALE_MS</a> </li><li data-api-symbol="pyric_worker_generation_key" data-astro-cid-mw7aashj> <a href="#pyric_worker_generation_key" data-astro-cid-mw7aashj>PYRIC_WORKER_GENERATION_KEY</a> </li><li data-api-symbol="pyric_worker_name" data-astro-cid-mw7aashj> <a href="#pyric_worker_name" data-astro-cid-mw7aashj>PYRIC_WORKER_NAME</a> </li><li data-api-symbol="pyric_worker_url" data-astro-cid-mw7aashj> <a href="#pyric_worker_url" data-astro-cid-mw7aashj>PYRIC_WORKER_URL</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#functions" data-astro-cid-mw7aashj> Functions </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="acceptprovidercredential()" data-astro-cid-mw7aashj> <a href="#acceptprovidercredential" data-astro-cid-mw7aashj>acceptProviderCredential()</a> </li><li data-api-symbol="adddoc()" data-astro-cid-mw7aashj> <a href="#adddoc" data-astro-cid-mw7aashj>addDoc()</a> </li><li data-api-symbol="adminclearusers()" data-astro-cid-mw7aashj> <a href="#adminclearusers" data-astro-cid-mw7aashj>adminClearUsers()</a> </li><li data-api-symbol="admincreateuser()" data-astro-cid-mw7aashj> <a href="#admincreateuser" data-astro-cid-mw7aashj>adminCreateUser()</a> </li><li data-api-symbol="admindeletedocument()" data-astro-cid-mw7aashj> <a href="#admindeletedocument" data-astro-cid-mw7aashj>adminDeleteDocument()</a> </li><li data-api-symbol="admindeletertdbvalue()" data-astro-cid-mw7aashj> <a href="#admindeletertdbvalue" data-astro-cid-mw7aashj>adminDeleteRtdbValue()</a> </li><li data-api-symbol="admindeleteuser()" data-astro-cid-mw7aashj> <a href="#admindeleteuser" data-astro-cid-mw7aashj>adminDeleteUser()</a> </li><li data-api-symbol="admingetdocument()" data-astro-cid-mw7aashj> <a href="#admingetdocument" data-astro-cid-mw7aashj>adminGetDocument()</a> </li><li data-api-symbol="adminlistdocuments()" data-astro-cid-mw7aashj> <a href="#adminlistdocuments" data-astro-cid-mw7aashj>adminListDocuments()</a> </li><li data-api-symbol="adminreadrtdbstate()" data-astro-cid-mw7aashj> <a href="#adminreadrtdbstate" data-astro-cid-mw7aashj>adminReadRtdbState()</a> </li><li data-api-symbol="adminreadstate()" data-astro-cid-mw7aashj> <a href="#adminreadstate" data-astro-cid-mw7aashj>adminReadState()</a> </li><li data-api-symbol="adminsetdocument()" data-astro-cid-mw7aashj> <a href="#adminsetdocument" data-astro-cid-mw7aashj>adminSetDocument()</a> </li><li data-api-symbol="adminsetrtdbvalue()" data-astro-cid-mw7aashj> <a href="#adminsetrtdbvalue" data-astro-cid-mw7aashj>adminSetRtdbValue()</a> </li><li data-api-symbol="adminsubscribertdbvalue()" data-astro-cid-mw7aashj> <a href="#adminsubscribertdbvalue" data-astro-cid-mw7aashj>adminSubscribeRtdbValue()</a> </li><li data-api-symbol="adminupdatertdbvalue()" data-astro-cid-mw7aashj> <a href="#adminupdatertdbvalue" data-astro-cid-mw7aashj>adminUpdateRtdbValue()</a> </li><li data-api-symbol="adminupdateuser()" data-astro-cid-mw7aashj> <a href="#adminupdateuser" data-astro-cid-mw7aashj>adminUpdateUser()</a> </li><li data-api-symbol="and()" data-astro-cid-mw7aashj> <a href="#and" data-astro-cid-mw7aashj>and()</a> </li><li data-api-symbol="arrayremove()" data-astro-cid-mw7aashj> <a href="#arrayremove" data-astro-cid-mw7aashj>arrayRemove()</a> </li><li data-api-symbol="arrayunion()" data-astro-cid-mw7aashj> <a href="#arrayunion" data-astro-cid-mw7aashj>arrayUnion()</a> </li><li data-api-symbol="average()" data-astro-cid-mw7aashj> <a href="#average" data-astro-cid-mw7aashj>average()</a> </li><li data-api-symbol="calltool()" data-astro-cid-mw7aashj> <a href="#calltool" data-astro-cid-mw7aashj>callTool()</a> </li><li data-api-symbol="collection()" data-astro-cid-mw7aashj> <a href="#collection" data-astro-cid-mw7aashj>collection()</a> </li><li data-api-symbol="collectiongroup()" data-astro-cid-mw7aashj> <a href="#collectiongroup" data-astro-cid-mw7aashj>collectionGroup()</a> </li><li data-api-symbol="connectauthemulator()" data-astro-cid-mw7aashj> <a href="#connectauthemulator" data-astro-cid-mw7aashj>connectAuthEmulator()</a> </li><li data-api-symbol="count()" data-astro-cid-mw7aashj> <a href="#count" data-astro-cid-mw7aashj>count()</a> </li><li data-api-symbol="createuserwithemailandpassword()" data-astro-cid-mw7aashj> <a href="#createuserwithemailandpassword" data-astro-cid-mw7aashj>createUserWithEmailAndPassword()</a> </li><li data-api-symbol="createworkerreplacement()" data-astro-cid-mw7aashj> <a href="#createworkerreplacement" data-astro-cid-mw7aashj>createWorkerReplacement()</a> </li><li data-api-symbol="deletedoc()" data-astro-cid-mw7aashj> <a href="#deletedoc" data-astro-cid-mw7aashj>deleteDoc()</a> </li><li data-api-symbol="deletefield()" data-astro-cid-mw7aashj> <a href="#deletefield" data-astro-cid-mw7aashj>deleteField()</a> </li><li data-api-symbol="deleteobject()" data-astro-cid-mw7aashj> <a href="#deleteobject" data-astro-cid-mw7aashj>deleteObject()</a> </li><li data-api-symbol="deleteworkerbranch()" data-astro-cid-mw7aashj> <a href="#deleteworkerbranch" data-astro-cid-mw7aashj>deleteWorkerBranch()</a> </li><li data-api-symbol="disconnectclient()" data-astro-cid-mw7aashj> <a href="#disconnectclient" data-astro-cid-mw7aashj>disconnectClient()</a> </li><li data-api-symbol="doc()" data-astro-cid-mw7aashj> <a href="#doc" data-astro-cid-mw7aashj>doc()</a> </li><li data-api-symbol="endat()" data-astro-cid-mw7aashj> <a href="#endat" data-astro-cid-mw7aashj>endAt()</a> </li><li data-api-symbol="endbefore()" data-astro-cid-mw7aashj> <a href="#endbefore" data-astro-cid-mw7aashj>endBefore()</a> </li><li data-api-symbol="eventhistory()" data-astro-cid-mw7aashj> <a href="#eventhistory" data-astro-cid-mw7aashj>eventHistory()</a> </li><li data-api-symbol="exportworkerstate()" data-astro-cid-mw7aashj> <a href="#exportworkerstate" data-astro-cid-mw7aashj>exportWorkerState()</a> </li><li data-api-symbol="getactiverules()" data-astro-cid-mw7aashj> <a href="#getactiverules" data-astro-cid-mw7aashj>getActiveRules()</a> </li><li data-api-symbol="getaggregatefromserver()" data-astro-cid-mw7aashj> <a href="#getaggregatefromserver" data-astro-cid-mw7aashj>getAggregateFromServer()</a> </li><li data-api-symbol="getauth()" data-astro-cid-mw7aashj> <a href="#getauth" data-astro-cid-mw7aashj>getAuth()</a> </li><li data-api-symbol="getblob()" data-astro-cid-mw7aashj> <a href="#getblob" data-astro-cid-mw7aashj>getBlob()</a> </li><li data-api-symbol="getbytes()" data-astro-cid-mw7aashj> <a href="#getbytes" data-astro-cid-mw7aashj>getBytes()</a> </li><li data-api-symbol="getcountfromserver()" data-astro-cid-mw7aashj> <a href="#getcountfromserver" data-astro-cid-mw7aashj>getCountFromServer()</a> </li><li data-api-symbol="getdoc()" data-astro-cid-mw7aashj> <a href="#getdoc" data-astro-cid-mw7aashj>getDoc()</a> </li><li data-api-symbol="getdocs()" data-astro-cid-mw7aashj> <a href="#getdocs" data-astro-cid-mw7aashj>getDocs()</a> </li><li data-api-symbol="getdownloadurl()" data-astro-cid-mw7aashj> <a href="#getdownloadurl" data-astro-cid-mw7aashj>getDownloadURL()</a> </li><li data-api-symbol="getfirestore()" data-astro-cid-mw7aashj> <a href="#getfirestore" data-astro-cid-mw7aashj>getFirestore()</a> </li><li data-api-symbol="getidtoken()" data-astro-cid-mw7aashj> <a href="#getidtoken-1" data-astro-cid-mw7aashj>getIdToken()</a> </li><li data-api-symbol="getidtokenresult()" data-astro-cid-mw7aashj> <a href="#getidtokenresult-1" data-astro-cid-mw7aashj>getIdTokenResult()</a> </li><li data-api-symbol="getlens()" data-astro-cid-mw7aashj> <a href="#getlens" data-astro-cid-mw7aashj>getLens()</a> </li><li data-api-symbol="getmetadata()" data-astro-cid-mw7aashj> <a href="#getmetadata" data-astro-cid-mw7aashj>getMetadata()</a> </li><li data-api-symbol="getproviderconfig()" data-astro-cid-mw7aashj> <a href="#getproviderconfig" data-astro-cid-mw7aashj>getProviderConfig()</a> </li><li data-api-symbol="getrulesstatus()" data-astro-cid-mw7aashj> <a href="#getrulesstatus" data-astro-cid-mw7aashj>getRulesStatus()</a> </li><li data-api-symbol="getsnapshot()" data-astro-cid-mw7aashj> <a href="#getsnapshot" data-astro-cid-mw7aashj>getSnapshot()</a> </li><li data-api-symbol="getstorage()" data-astro-cid-mw7aashj> <a href="#getstorage" data-astro-cid-mw7aashj>getStorage()</a> </li><li data-api-symbol="getworkerinstanceid()" data-astro-cid-mw7aashj> <a href="#getworkerinstanceid" data-astro-cid-mw7aashj>getWorkerInstanceId()</a> </li><li data-api-symbol="getworkerversion()" data-astro-cid-mw7aashj> <a href="#getworkerversion" data-astro-cid-mw7aashj>getWorkerVersion()</a> </li><li data-api-symbol="importworkerstate()" data-astro-cid-mw7aashj> <a href="#importworkerstate" data-astro-cid-mw7aashj>importWorkerState()</a> </li><li data-api-symbol="increment()" data-astro-cid-mw7aashj> <a href="#increment" data-astro-cid-mw7aashj>increment()</a> </li><li data-api-symbol="limit()" data-astro-cid-mw7aashj> <a href="#limit" data-astro-cid-mw7aashj>limit()</a> </li><li data-api-symbol="limittolast()" data-astro-cid-mw7aashj> <a href="#limittolast" data-astro-cid-mw7aashj>limitToLast()</a> </li><li data-api-symbol="listall()" data-astro-cid-mw7aashj> <a href="#listall" data-astro-cid-mw7aashj>listAll()</a> </li><li data-api-symbol="listrootcollections()" data-astro-cid-mw7aashj> <a href="#listrootcollections" data-astro-cid-mw7aashj>listRootCollections()</a> </li><li data-api-symbol="listsubcollections()" data-astro-cid-mw7aashj> <a href="#listsubcollections" data-astro-cid-mw7aashj>listSubcollections()</a> </li><li data-api-symbol="listusers()" data-astro-cid-mw7aashj> <a href="#listusers" data-astro-cid-mw7aashj>listUsers()</a> </li><li data-api-symbol="listworkerbranches()" data-astro-cid-mw7aashj> <a href="#listworkerbranches" data-astro-cid-mw7aashj>listWorkerBranches()</a> </li><li data-api-symbol="mintpresenceclientid()" data-astro-cid-mw7aashj> <a href="#mintpresenceclientid" data-astro-cid-mw7aashj>mintPresenceClientId()</a> </li><li data-api-symbol="onauthstatechanged()" data-astro-cid-mw7aashj> <a href="#onauthstatechanged" data-astro-cid-mw7aashj>onAuthStateChanged()</a> </li><li data-api-symbol="onidtokenchanged()" data-astro-cid-mw7aashj> <a href="#onidtokenchanged" data-astro-cid-mw7aashj>onIdTokenChanged()</a> </li><li data-api-symbol="onsnapshot()" data-astro-cid-mw7aashj> <a href="#onsnapshot" data-astro-cid-mw7aashj>onSnapshot()</a> </li><li data-api-symbol="onworkerruntimereload()" data-astro-cid-mw7aashj> <a href="#onworkerruntimereload" data-astro-cid-mw7aashj>onWorkerRuntimeReload()</a> </li><li data-api-symbol="or()" data-astro-cid-mw7aashj> <a href="#or" data-astro-cid-mw7aashj>or()</a> </li><li data-api-symbol="orderby()" data-astro-cid-mw7aashj> <a href="#orderby" data-astro-cid-mw7aashj>orderBy()</a> </li><li data-api-symbol="ownclientuntilpagehide()" data-astro-cid-mw7aashj> <a href="#ownclientuntilpagehide" data-astro-cid-mw7aashj>ownClientUntilPagehide()</a> </li><li data-api-symbol="preflightworkerepochstorage()" data-astro-cid-mw7aashj> <a href="#preflightworkerepochstorage" data-astro-cid-mw7aashj>preflightWorkerEpochStorage()</a> </li><li data-api-symbol="query()" data-astro-cid-mw7aashj> <a href="#query" data-astro-cid-mw7aashj>query()</a> </li><li data-api-symbol="readpyricruntimemanifest()" data-astro-cid-mw7aashj> <a href="#readpyricruntimemanifest" data-astro-cid-mw7aashj>readPyricRuntimeManifest()</a> </li><li data-api-symbol="ref()" data-astro-cid-mw7aashj> <a href="#ref" data-astro-cid-mw7aashj>ref()</a> </li><li data-api-symbol="relayworkerop()" data-astro-cid-mw7aashj> <a href="#relayworkerop" data-astro-cid-mw7aashj>relayWorkerOp()</a> </li><li data-api-symbol="relayworkersub()" data-astro-cid-mw7aashj> <a href="#relayworkersub" data-astro-cid-mw7aashj>relayWorkerSub()</a> </li><li data-api-symbol="rememberworkerepoch()" data-astro-cid-mw7aashj> <a href="#rememberworkerepoch" data-astro-cid-mw7aashj>rememberWorkerEpoch()</a> </li><li data-api-symbol="resetall()" data-astro-cid-mw7aashj> <a href="#resetall" data-astro-cid-mw7aashj>resetAll()</a> </li><li data-api-symbol="retireworkerruntime()" data-astro-cid-mw7aashj> <a href="#retireworkerruntime" data-astro-cid-mw7aashj>retireWorkerRuntime()</a> </li><li data-api-symbol="rtdbchild()" data-astro-cid-mw7aashj> <a href="#rtdbchild" data-astro-cid-mw7aashj>rtdbChild()</a> </li><li data-api-symbol="rtdbconnectdatabaseemulator()" data-astro-cid-mw7aashj> <a href="#rtdbconnectdatabaseemulator" data-astro-cid-mw7aashj>rtdbConnectDatabaseEmulator()</a> </li><li data-api-symbol="rtdbget()" data-astro-cid-mw7aashj> <a href="#rtdbget" data-astro-cid-mw7aashj>rtdbGet()</a> </li><li data-api-symbol="rtdbgetdatabase()" data-astro-cid-mw7aashj> <a href="#rtdbgetdatabase" data-astro-cid-mw7aashj>rtdbGetDatabase()</a> </li><li data-api-symbol="rtdbgooffline()" data-astro-cid-mw7aashj> <a href="#rtdbgooffline" data-astro-cid-mw7aashj>rtdbGoOffline()</a> </li><li data-api-symbol="rtdbgoonline()" data-astro-cid-mw7aashj> <a href="#rtdbgoonline" data-astro-cid-mw7aashj>rtdbGoOnline()</a> </li><li data-api-symbol="rtdboff()" data-astro-cid-mw7aashj> <a href="#rtdboff" data-astro-cid-mw7aashj>rtdbOff()</a> </li><li data-api-symbol="rtdbonchildadded()" data-astro-cid-mw7aashj> <a href="#rtdbonchildadded" data-astro-cid-mw7aashj>rtdbOnChildAdded()</a> </li><li data-api-symbol="rtdbonchildchanged()" data-astro-cid-mw7aashj> <a href="#rtdbonchildchanged" data-astro-cid-mw7aashj>rtdbOnChildChanged()</a> </li><li data-api-symbol="rtdbonchildmoved()" data-astro-cid-mw7aashj> <a href="#rtdbonchildmoved" data-astro-cid-mw7aashj>rtdbOnChildMoved()</a> </li><li data-api-symbol="rtdbonchildremoved()" data-astro-cid-mw7aashj> <a href="#rtdbonchildremoved" data-astro-cid-mw7aashj>rtdbOnChildRemoved()</a> </li><li data-api-symbol="rtdbondisconnect()" data-astro-cid-mw7aashj> <a href="#rtdbondisconnect-1" data-astro-cid-mw7aashj>rtdbOnDisconnect()</a> </li><li data-api-symbol="rtdbonvalue()" data-astro-cid-mw7aashj> <a href="#rtdbonvalue" data-astro-cid-mw7aashj>rtdbOnValue()</a> </li><li data-api-symbol="rtdbpush()" data-astro-cid-mw7aashj> <a href="#rtdbpush" data-astro-cid-mw7aashj>rtdbPush()</a> </li><li data-api-symbol="rtdbref()" data-astro-cid-mw7aashj> <a href="#rtdbref" data-astro-cid-mw7aashj>rtdbRef()</a> </li><li data-api-symbol="rtdbremove()" data-astro-cid-mw7aashj> <a href="#rtdbremove" data-astro-cid-mw7aashj>rtdbRemove()</a> </li><li data-api-symbol="rtdbruntransaction()" data-astro-cid-mw7aashj> <a href="#rtdbruntransaction" data-astro-cid-mw7aashj>rtdbRunTransaction()</a> </li><li data-api-symbol="rtdbservertimestamp()" data-astro-cid-mw7aashj> <a href="#rtdbservertimestamp" data-astro-cid-mw7aashj>rtdbServerTimestamp()</a> </li><li data-api-symbol="rtdbset()" data-astro-cid-mw7aashj> <a href="#rtdbset" data-astro-cid-mw7aashj>rtdbSet()</a> </li><li data-api-symbol="rtdbsetpriority()" data-astro-cid-mw7aashj> <a href="#rtdbsetpriority" data-astro-cid-mw7aashj>rtdbSetPriority()</a> </li><li data-api-symbol="rtdbsetwithpriority()" data-astro-cid-mw7aashj> <a href="#rtdbsetwithpriority" data-astro-cid-mw7aashj>rtdbSetWithPriority()</a> </li><li data-api-symbol="rtdbupdate()" data-astro-cid-mw7aashj> <a href="#rtdbupdate" data-astro-cid-mw7aashj>rtdbUpdate()</a> </li><li data-api-symbol="runtransaction()" data-astro-cid-mw7aashj> <a href="#runtransaction" data-astro-cid-mw7aashj>runTransaction()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#multi-tab-correctness--read-set-validation--retry" data-astro-cid-mw7aashj> MULTI-TAB CORRECTNESS — READ-SET VALIDATION + RETRY </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="saveworkerbranch()" data-astro-cid-mw7aashj> <a href="#saveworkerbranch" data-astro-cid-mw7aashj>saveWorkerBranch()</a> </li><li data-api-symbol="servertimestamp()" data-astro-cid-mw7aashj> <a href="#servertimestamp" data-astro-cid-mw7aashj>serverTimestamp()</a> </li><li data-api-symbol="setdatabaserules()" data-astro-cid-mw7aashj> <a href="#setdatabaserules" data-astro-cid-mw7aashj>setDatabaseRules()</a> </li><li data-api-symbol="setdoc()" data-astro-cid-mw7aashj> <a href="#setdoc" data-astro-cid-mw7aashj>setDoc()</a> </li><li data-api-symbol="setfirestorerules()" data-astro-cid-mw7aashj> <a href="#setfirestorerules" data-astro-cid-mw7aashj>setFirestoreRules()</a> </li><li data-api-symbol="setlens()" data-astro-cid-mw7aashj> <a href="#setlens" data-astro-cid-mw7aashj>setLens()</a> </li><li data-api-symbol="setopissuer()" data-astro-cid-mw7aashj> <a href="#setopissuer" data-astro-cid-mw7aashj>setOpIssuer()</a> </li><li data-api-symbol="setpersistence()" data-astro-cid-mw7aashj> <a href="#setpersistence" data-astro-cid-mw7aashj>setPersistence()</a> </li><li data-api-symbol="setproviderconfig()" data-astro-cid-mw7aashj> <a href="#setproviderconfig" data-astro-cid-mw7aashj>setProviderConfig()</a> </li><li data-api-symbol="setrules()" data-astro-cid-mw7aashj> <a href="#setrules" data-astro-cid-mw7aashj>setRules()</a> </li><li data-api-symbol="signinanonymously()" data-astro-cid-mw7aashj> <a href="#signinanonymously" data-astro-cid-mw7aashj>signInAnonymously()</a> </li><li data-api-symbol="signinwithemailandpassword()" data-astro-cid-mw7aashj> <a href="#signinwithemailandpassword" data-astro-cid-mw7aashj>signInWithEmailAndPassword()</a> </li><li data-api-symbol="signout()" data-astro-cid-mw7aashj> <a href="#signout" data-astro-cid-mw7aashj>signOut()</a> </li><li data-api-symbol="startafter()" data-astro-cid-mw7aashj> <a href="#startafter" data-astro-cid-mw7aashj>startAfter()</a> </li><li data-api-symbol="startat()" data-astro-cid-mw7aashj> <a href="#startat" data-astro-cid-mw7aashj>startAt()</a> </li><li data-api-symbol="startpresence()" data-astro-cid-mw7aashj> <a href="#startpresence" data-astro-cid-mw7aashj>startPresence()</a> </li><li data-api-symbol="subscribeevents()" data-astro-cid-mw7aashj> <a href="#subscribeevents" data-astro-cid-mw7aashj>subscribeEvents()</a> </li><li data-api-symbol="subscribepresence()" data-astro-cid-mw7aashj> <a href="#subscribepresence" data-astro-cid-mw7aashj>subscribePresence()</a> </li><li data-api-symbol="sum()" data-astro-cid-mw7aashj> <a href="#sum" data-astro-cid-mw7aashj>sum()</a> </li><li data-api-symbol="switchworkerbranch()" data-astro-cid-mw7aashj> <a href="#switchworkerbranch" data-astro-cid-mw7aashj>switchWorkerBranch()</a> </li><li data-api-symbol="updatedoc()" data-astro-cid-mw7aashj> <a href="#updatedoc" data-astro-cid-mw7aashj>updateDoc()</a> </li><li data-api-symbol="uploadbytes()" data-astro-cid-mw7aashj> <a href="#uploadbytes" data-astro-cid-mw7aashj>uploadBytes()</a> </li><li data-api-symbol="uploadbytesresumable()" data-astro-cid-mw7aashj> <a href="#uploadbytesresumable" data-astro-cid-mw7aashj>uploadBytesResumable()</a> </li><li data-api-symbol="uploadstring()" data-astro-cid-mw7aashj> <a href="#uploadstring" data-astro-cid-mw7aashj>uploadString()</a> </li><li data-api-symbol="where()" data-astro-cid-mw7aashj> <a href="#where" data-astro-cid-mw7aashj>where()</a> </li><li data-api-symbol="workernameforepoch()" data-astro-cid-mw7aashj> <a href="#workernameforepoch" data-astro-cid-mw7aashj>workerNameForEpoch()</a> </li><li data-api-symbol="writebatch()" data-astro-cid-mw7aashj> <a href="#writebatch" data-astro-cid-mw7aashj>writeBatch()</a> </li> </ul> </section> <p class="api-symbol-empty" data-api-symbol-empty hidden data-astro-cid-mw7aashj>No matching symbols</p> </div> </aside> </div> <script type="module">const a=document.querySelector("[data-api-symbol-filter]"),d=[...document.querySelectorAll("[data-api-symbol-group]")],n=document.querySelector("[data-api-symbol-empty]");a?.addEventListener("input",()=>{const t=a.value.trim().toLowerCase();let o=0;for(const i of d){let e=0;i.querySelectorAll("[data-api-symbol]").forEach(l=>{const r=!t||(l.dataset.apiSymbol??"").includes(t);l.hidden=!r,r&&e++}),i.hidden=e===0,o+=e}n&&(n.hidden=o>0)});</script> <script type="module">const s=new Map;document.querySelectorAll('.doc-toc a[href^="#"]').forEach(t=>s.set(decodeURIComponent(t.hash.slice(1)),t));if(s.size>0){const t=new Set,n=()=>{let o=null;for(const e of s.keys())if(t.has(e)){o=e;break}s.forEach((e,c)=>e.classList.toggle("active",c===o))},r=new IntersectionObserver(o=>{for(const e of o)e.isIntersecting?t.add(e.target.id):t.delete(e.target.id);n()},{rootMargin:"-72px 0px -60% 0px"});s.forEach((o,e)=>{const c=document.getElementById(e);c&&r.observe(c)})}</script> <script type="module">document.querySelector('.studio__nav [aria-current="page"]')?.scrollIntoView({block:"nearest",inline:"center"});</script> </body></html>
|
|
5252
|
+
<h4 id="returns-178">Returns</h4>
|
|
5253
|
+
<p><a href="#clientwritebatch"><code>ClientWriteBatch</code></a></p> </article> </main> <aside class="doc-toc api-symbols" aria-label="API symbols" data-astro-cid-mw7aashj> <h2 class="doc-toc-heading" data-astro-cid-mw7aashj>Symbols</h2> <input class="api-symbol-filter" type="search" placeholder="Filter symbols" aria-label="Filter API symbols" data-api-symbol-filter data-astro-cid-mw7aashj> <div class="api-symbol-groups" data-api-symbol-groups data-astro-cid-mw7aashj> <section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#classes" data-astro-cid-mw7aashj> Classes </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="rtdbondisconnect" data-astro-cid-mw7aashj> <a href="#rtdbondisconnect" data-astro-cid-mw7aashj>RtdbOnDisconnect</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#interfaces" data-astro-cid-mw7aashj> Interfaces </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="clientauth" data-astro-cid-mw7aashj> <a href="#clientauth" data-astro-cid-mw7aashj>ClientAuth</a> </li><li data-api-symbol="clientdb" data-astro-cid-mw7aashj> <a href="#clientdb" data-astro-cid-mw7aashj>ClientDb</a> </li><li data-api-symbol="clientdocsnapshot" data-astro-cid-mw7aashj> <a href="#clientdocsnapshot" data-astro-cid-mw7aashj>ClientDocSnapshot</a> </li><li data-api-symbol="clientfirebasestorage" data-astro-cid-mw7aashj> <a href="#clientfirebasestorage" data-astro-cid-mw7aashj>ClientFirebaseStorage</a> </li><li data-api-symbol="clientquerysnapshot" data-astro-cid-mw7aashj> <a href="#clientquerysnapshot" data-astro-cid-mw7aashj>ClientQuerySnapshot</a> </li><li data-api-symbol="clientrtdb" data-astro-cid-mw7aashj> <a href="#clientrtdb" data-astro-cid-mw7aashj>ClientRtdb</a> </li><li data-api-symbol="clientsettablemetadata" data-astro-cid-mw7aashj> <a href="#clientsettablemetadata" data-astro-cid-mw7aashj>ClientSettableMetadata</a> </li><li data-api-symbol="clientstoragereference" data-astro-cid-mw7aashj> <a href="#clientstoragereference" data-astro-cid-mw7aashj>ClientStorageReference</a> </li><li data-api-symbol="clienttransaction" data-astro-cid-mw7aashj> <a href="#clienttransaction" data-astro-cid-mw7aashj>ClientTransaction</a> </li><li data-api-symbol="clientuploadtask" data-astro-cid-mw7aashj> <a href="#clientuploadtask" data-astro-cid-mw7aashj>ClientUploadTask</a> </li><li data-api-symbol="clientuploadtasksnapshot" data-astro-cid-mw7aashj> <a href="#clientuploadtasksnapshot" data-astro-cid-mw7aashj>ClientUploadTaskSnapshot</a> </li><li data-api-symbol="clientuser" data-astro-cid-mw7aashj> <a href="#clientuser" data-astro-cid-mw7aashj>ClientUser</a> </li><li data-api-symbol="clientusercredential" data-astro-cid-mw7aashj> <a href="#clientusercredential" data-astro-cid-mw7aashj>ClientUserCredential</a> </li><li data-api-symbol="clientwritebatch" data-astro-cid-mw7aashj> <a href="#clientwritebatch" data-astro-cid-mw7aashj>ClientWriteBatch</a> </li><li data-api-symbol="collrefhandle" data-astro-cid-mw7aashj> <a href="#collrefhandle" data-astro-cid-mw7aashj>CollRefHandle</a> </li><li data-api-symbol="disconnectclientoptions" data-astro-cid-mw7aashj> <a href="#disconnectclientoptions" data-astro-cid-mw7aashj>DisconnectClientOptions</a> </li><li data-api-symbol="docrefhandle" data-astro-cid-mw7aashj> <a href="#docrefhandle" data-astro-cid-mw7aashj>DocRefHandle</a> </li><li data-api-symbol="presencesession" data-astro-cid-mw7aashj> <a href="#presencesession" data-astro-cid-mw7aashj>PresenceSession</a> </li><li data-api-symbol="presencesnapshot" data-astro-cid-mw7aashj> <a href="#presencesnapshot" data-astro-cid-mw7aashj>PresenceSnapshot</a> </li><li data-api-symbol="pyricruntimemanifest" data-astro-cid-mw7aashj> <a href="#pyricruntimemanifest" data-astro-cid-mw7aashj>PyricRuntimeManifest</a> </li><li data-api-symbol="queryhandle" data-astro-cid-mw7aashj> <a href="#queryhandle" data-astro-cid-mw7aashj>QueryHandle</a> </li><li data-api-symbol="resolvedidentity" data-astro-cid-mw7aashj> <a href="#resolvedidentity" data-astro-cid-mw7aashj>ResolvedIdentity</a> </li><li data-api-symbol="rtdbdatasnapshot" data-astro-cid-mw7aashj> <a href="#rtdbdatasnapshot" data-astro-cid-mw7aashj>RtdbDataSnapshot</a> </li><li data-api-symbol="rtdbrefhandle" data-astro-cid-mw7aashj> <a href="#rtdbrefhandle" data-astro-cid-mw7aashj>RtdbRefHandle</a> </li><li data-api-symbol="serializedidtokenresult" data-astro-cid-mw7aashj> <a href="#serializedidtokenresult" data-astro-cid-mw7aashj>SerializedIdTokenResult</a> </li><li data-api-symbol="serializeduser" data-astro-cid-mw7aashj> <a href="#serializeduser" data-astro-cid-mw7aashj>SerializedUser</a> </li><li data-api-symbol="serializedusercredential" data-astro-cid-mw7aashj> <a href="#serializedusercredential" data-astro-cid-mw7aashj>SerializedUserCredential</a> </li><li data-api-symbol="workerreplacement" data-astro-cid-mw7aashj> <a href="#workerreplacement" data-astro-cid-mw7aashj>WorkerReplacement</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#type-aliases" data-astro-cid-mw7aashj> Type Aliases </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="anyhandle" data-astro-cid-mw7aashj> <a href="#anyhandle" data-astro-cid-mw7aashj>AnyHandle</a> </li><li data-api-symbol="authpersistencemode" data-astro-cid-mw7aashj> <a href="#authpersistencemode" data-astro-cid-mw7aashj>AuthPersistenceMode</a> </li><li data-api-symbol="presenceclientkind" data-astro-cid-mw7aashj> <a href="#presenceclientkind" data-astro-cid-mw7aashj>PresenceClientKind</a> </li><li data-api-symbol="presencevisibility" data-astro-cid-mw7aashj> <a href="#presencevisibility" data-astro-cid-mw7aashj>PresenceVisibility</a> </li><li data-api-symbol="unsubscribe()" data-astro-cid-mw7aashj> <a href="#unsubscribe" data-astro-cid-mw7aashj>Unsubscribe()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#variables" data-astro-cid-mw7aashj> Variables </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="auth_lens_storage_key" data-astro-cid-mw7aashj> <a href="#auth_lens_storage_key" data-astro-cid-mw7aashj>AUTH_LENS_STORAGE_KEY</a> </li><li data-api-symbol="browserlocalpersistence" data-astro-cid-mw7aashj> <a href="#browserlocalpersistence" data-astro-cid-mw7aashj>browserLocalPersistence</a> </li><li data-api-symbol="browsersessionpersistence" data-astro-cid-mw7aashj> <a href="#browsersessionpersistence" data-astro-cid-mw7aashj>browserSessionPersistence</a> </li><li data-api-symbol="inmemorypersistence" data-astro-cid-mw7aashj> <a href="#inmemorypersistence" data-astro-cid-mw7aashj>inMemoryPersistence</a> </li><li data-api-symbol="presence_heartbeat_interval_ms" data-astro-cid-mw7aashj> <a href="#presence_heartbeat_interval_ms" data-astro-cid-mw7aashj>PRESENCE_HEARTBEAT_INTERVAL_MS</a> </li><li data-api-symbol="presence_stale_ms" data-astro-cid-mw7aashj> <a href="#presence_stale_ms" data-astro-cid-mw7aashj>PRESENCE_STALE_MS</a> </li><li data-api-symbol="pyric_worker_generation_key" data-astro-cid-mw7aashj> <a href="#pyric_worker_generation_key" data-astro-cid-mw7aashj>PYRIC_WORKER_GENERATION_KEY</a> </li><li data-api-symbol="pyric_worker_name" data-astro-cid-mw7aashj> <a href="#pyric_worker_name" data-astro-cid-mw7aashj>PYRIC_WORKER_NAME</a> </li><li data-api-symbol="pyric_worker_url" data-astro-cid-mw7aashj> <a href="#pyric_worker_url" data-astro-cid-mw7aashj>PYRIC_WORKER_URL</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#functions" data-astro-cid-mw7aashj> Functions </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="acceptprovidercredential()" data-astro-cid-mw7aashj> <a href="#acceptprovidercredential" data-astro-cid-mw7aashj>acceptProviderCredential()</a> </li><li data-api-symbol="adddoc()" data-astro-cid-mw7aashj> <a href="#adddoc" data-astro-cid-mw7aashj>addDoc()</a> </li><li data-api-symbol="adminclearusers()" data-astro-cid-mw7aashj> <a href="#adminclearusers" data-astro-cid-mw7aashj>adminClearUsers()</a> </li><li data-api-symbol="admincreateuser()" data-astro-cid-mw7aashj> <a href="#admincreateuser" data-astro-cid-mw7aashj>adminCreateUser()</a> </li><li data-api-symbol="admindeletedocument()" data-astro-cid-mw7aashj> <a href="#admindeletedocument" data-astro-cid-mw7aashj>adminDeleteDocument()</a> </li><li data-api-symbol="admindeletertdbvalue()" data-astro-cid-mw7aashj> <a href="#admindeletertdbvalue" data-astro-cid-mw7aashj>adminDeleteRtdbValue()</a> </li><li data-api-symbol="admindeleteuser()" data-astro-cid-mw7aashj> <a href="#admindeleteuser" data-astro-cid-mw7aashj>adminDeleteUser()</a> </li><li data-api-symbol="admingetdocument()" data-astro-cid-mw7aashj> <a href="#admingetdocument" data-astro-cid-mw7aashj>adminGetDocument()</a> </li><li data-api-symbol="adminlistdocuments()" data-astro-cid-mw7aashj> <a href="#adminlistdocuments" data-astro-cid-mw7aashj>adminListDocuments()</a> </li><li data-api-symbol="adminreadrtdbstate()" data-astro-cid-mw7aashj> <a href="#adminreadrtdbstate" data-astro-cid-mw7aashj>adminReadRtdbState()</a> </li><li data-api-symbol="adminreadstate()" data-astro-cid-mw7aashj> <a href="#adminreadstate" data-astro-cid-mw7aashj>adminReadState()</a> </li><li data-api-symbol="adminsetdocument()" data-astro-cid-mw7aashj> <a href="#adminsetdocument" data-astro-cid-mw7aashj>adminSetDocument()</a> </li><li data-api-symbol="adminsetrtdbvalue()" data-astro-cid-mw7aashj> <a href="#adminsetrtdbvalue" data-astro-cid-mw7aashj>adminSetRtdbValue()</a> </li><li data-api-symbol="adminsubscribertdbvalue()" data-astro-cid-mw7aashj> <a href="#adminsubscribertdbvalue" data-astro-cid-mw7aashj>adminSubscribeRtdbValue()</a> </li><li data-api-symbol="adminupdatertdbvalue()" data-astro-cid-mw7aashj> <a href="#adminupdatertdbvalue" data-astro-cid-mw7aashj>adminUpdateRtdbValue()</a> </li><li data-api-symbol="adminupdateuser()" data-astro-cid-mw7aashj> <a href="#adminupdateuser" data-astro-cid-mw7aashj>adminUpdateUser()</a> </li><li data-api-symbol="and()" data-astro-cid-mw7aashj> <a href="#and" data-astro-cid-mw7aashj>and()</a> </li><li data-api-symbol="arrayremove()" data-astro-cid-mw7aashj> <a href="#arrayremove" data-astro-cid-mw7aashj>arrayRemove()</a> </li><li data-api-symbol="arrayunion()" data-astro-cid-mw7aashj> <a href="#arrayunion" data-astro-cid-mw7aashj>arrayUnion()</a> </li><li data-api-symbol="average()" data-astro-cid-mw7aashj> <a href="#average" data-astro-cid-mw7aashj>average()</a> </li><li data-api-symbol="calltool()" data-astro-cid-mw7aashj> <a href="#calltool" data-astro-cid-mw7aashj>callTool()</a> </li><li data-api-symbol="collection()" data-astro-cid-mw7aashj> <a href="#collection" data-astro-cid-mw7aashj>collection()</a> </li><li data-api-symbol="collectiongroup()" data-astro-cid-mw7aashj> <a href="#collectiongroup" data-astro-cid-mw7aashj>collectionGroup()</a> </li><li data-api-symbol="connectauthemulator()" data-astro-cid-mw7aashj> <a href="#connectauthemulator" data-astro-cid-mw7aashj>connectAuthEmulator()</a> </li><li data-api-symbol="count()" data-astro-cid-mw7aashj> <a href="#count" data-astro-cid-mw7aashj>count()</a> </li><li data-api-symbol="createuserwithemailandpassword()" data-astro-cid-mw7aashj> <a href="#createuserwithemailandpassword" data-astro-cid-mw7aashj>createUserWithEmailAndPassword()</a> </li><li data-api-symbol="createworkerreplacement()" data-astro-cid-mw7aashj> <a href="#createworkerreplacement" data-astro-cid-mw7aashj>createWorkerReplacement()</a> </li><li data-api-symbol="deletedoc()" data-astro-cid-mw7aashj> <a href="#deletedoc" data-astro-cid-mw7aashj>deleteDoc()</a> </li><li data-api-symbol="deletefield()" data-astro-cid-mw7aashj> <a href="#deletefield" data-astro-cid-mw7aashj>deleteField()</a> </li><li data-api-symbol="deleteobject()" data-astro-cid-mw7aashj> <a href="#deleteobject" data-astro-cid-mw7aashj>deleteObject()</a> </li><li data-api-symbol="deleteworkerbranch()" data-astro-cid-mw7aashj> <a href="#deleteworkerbranch" data-astro-cid-mw7aashj>deleteWorkerBranch()</a> </li><li data-api-symbol="disconnectclient()" data-astro-cid-mw7aashj> <a href="#disconnectclient" data-astro-cid-mw7aashj>disconnectClient()</a> </li><li data-api-symbol="doc()" data-astro-cid-mw7aashj> <a href="#doc" data-astro-cid-mw7aashj>doc()</a> </li><li data-api-symbol="endat()" data-astro-cid-mw7aashj> <a href="#endat" data-astro-cid-mw7aashj>endAt()</a> </li><li data-api-symbol="endbefore()" data-astro-cid-mw7aashj> <a href="#endbefore" data-astro-cid-mw7aashj>endBefore()</a> </li><li data-api-symbol="eventhistory()" data-astro-cid-mw7aashj> <a href="#eventhistory" data-astro-cid-mw7aashj>eventHistory()</a> </li><li data-api-symbol="exportworkerstate()" data-astro-cid-mw7aashj> <a href="#exportworkerstate" data-astro-cid-mw7aashj>exportWorkerState()</a> </li><li data-api-symbol="getactiverules()" data-astro-cid-mw7aashj> <a href="#getactiverules" data-astro-cid-mw7aashj>getActiveRules()</a> </li><li data-api-symbol="getaggregatefromserver()" data-astro-cid-mw7aashj> <a href="#getaggregatefromserver" data-astro-cid-mw7aashj>getAggregateFromServer()</a> </li><li data-api-symbol="getauth()" data-astro-cid-mw7aashj> <a href="#getauth" data-astro-cid-mw7aashj>getAuth()</a> </li><li data-api-symbol="getblob()" data-astro-cid-mw7aashj> <a href="#getblob" data-astro-cid-mw7aashj>getBlob()</a> </li><li data-api-symbol="getbytes()" data-astro-cid-mw7aashj> <a href="#getbytes" data-astro-cid-mw7aashj>getBytes()</a> </li><li data-api-symbol="getcountfromserver()" data-astro-cid-mw7aashj> <a href="#getcountfromserver" data-astro-cid-mw7aashj>getCountFromServer()</a> </li><li data-api-symbol="getdoc()" data-astro-cid-mw7aashj> <a href="#getdoc" data-astro-cid-mw7aashj>getDoc()</a> </li><li data-api-symbol="getdocs()" data-astro-cid-mw7aashj> <a href="#getdocs" data-astro-cid-mw7aashj>getDocs()</a> </li><li data-api-symbol="getdownloadurl()" data-astro-cid-mw7aashj> <a href="#getdownloadurl" data-astro-cid-mw7aashj>getDownloadURL()</a> </li><li data-api-symbol="getfirestore()" data-astro-cid-mw7aashj> <a href="#getfirestore" data-astro-cid-mw7aashj>getFirestore()</a> </li><li data-api-symbol="getidtoken()" data-astro-cid-mw7aashj> <a href="#getidtoken-1" data-astro-cid-mw7aashj>getIdToken()</a> </li><li data-api-symbol="getidtokenresult()" data-astro-cid-mw7aashj> <a href="#getidtokenresult-1" data-astro-cid-mw7aashj>getIdTokenResult()</a> </li><li data-api-symbol="getlens()" data-astro-cid-mw7aashj> <a href="#getlens" data-astro-cid-mw7aashj>getLens()</a> </li><li data-api-symbol="getmetadata()" data-astro-cid-mw7aashj> <a href="#getmetadata" data-astro-cid-mw7aashj>getMetadata()</a> </li><li data-api-symbol="getproviderconfig()" data-astro-cid-mw7aashj> <a href="#getproviderconfig" data-astro-cid-mw7aashj>getProviderConfig()</a> </li><li data-api-symbol="getrulesstatus()" data-astro-cid-mw7aashj> <a href="#getrulesstatus" data-astro-cid-mw7aashj>getRulesStatus()</a> </li><li data-api-symbol="getsnapshot()" data-astro-cid-mw7aashj> <a href="#getsnapshot" data-astro-cid-mw7aashj>getSnapshot()</a> </li><li data-api-symbol="getstorage()" data-astro-cid-mw7aashj> <a href="#getstorage" data-astro-cid-mw7aashj>getStorage()</a> </li><li data-api-symbol="getworkerinstanceid()" data-astro-cid-mw7aashj> <a href="#getworkerinstanceid" data-astro-cid-mw7aashj>getWorkerInstanceId()</a> </li><li data-api-symbol="getworkerversion()" data-astro-cid-mw7aashj> <a href="#getworkerversion" data-astro-cid-mw7aashj>getWorkerVersion()</a> </li><li data-api-symbol="hydratelensfromstorage()" data-astro-cid-mw7aashj> <a href="#hydratelensfromstorage" data-astro-cid-mw7aashj>hydrateLensFromStorage()</a> </li><li data-api-symbol="importworkerstate()" data-astro-cid-mw7aashj> <a href="#importworkerstate" data-astro-cid-mw7aashj>importWorkerState()</a> </li><li data-api-symbol="increment()" data-astro-cid-mw7aashj> <a href="#increment" data-astro-cid-mw7aashj>increment()</a> </li><li data-api-symbol="limit()" data-astro-cid-mw7aashj> <a href="#limit" data-astro-cid-mw7aashj>limit()</a> </li><li data-api-symbol="limittolast()" data-astro-cid-mw7aashj> <a href="#limittolast" data-astro-cid-mw7aashj>limitToLast()</a> </li><li data-api-symbol="listall()" data-astro-cid-mw7aashj> <a href="#listall" data-astro-cid-mw7aashj>listAll()</a> </li><li data-api-symbol="listrootcollections()" data-astro-cid-mw7aashj> <a href="#listrootcollections" data-astro-cid-mw7aashj>listRootCollections()</a> </li><li data-api-symbol="listsubcollections()" data-astro-cid-mw7aashj> <a href="#listsubcollections" data-astro-cid-mw7aashj>listSubcollections()</a> </li><li data-api-symbol="listusers()" data-astro-cid-mw7aashj> <a href="#listusers" data-astro-cid-mw7aashj>listUsers()</a> </li><li data-api-symbol="listworkerbranches()" data-astro-cid-mw7aashj> <a href="#listworkerbranches" data-astro-cid-mw7aashj>listWorkerBranches()</a> </li><li data-api-symbol="mintpresenceclientid()" data-astro-cid-mw7aashj> <a href="#mintpresenceclientid" data-astro-cid-mw7aashj>mintPresenceClientId()</a> </li><li data-api-symbol="onauthstatechanged()" data-astro-cid-mw7aashj> <a href="#onauthstatechanged" data-astro-cid-mw7aashj>onAuthStateChanged()</a> </li><li data-api-symbol="onidtokenchanged()" data-astro-cid-mw7aashj> <a href="#onidtokenchanged" data-astro-cid-mw7aashj>onIdTokenChanged()</a> </li><li data-api-symbol="onsnapshot()" data-astro-cid-mw7aashj> <a href="#onsnapshot" data-astro-cid-mw7aashj>onSnapshot()</a> </li><li data-api-symbol="onworkerruntimereload()" data-astro-cid-mw7aashj> <a href="#onworkerruntimereload" data-astro-cid-mw7aashj>onWorkerRuntimeReload()</a> </li><li data-api-symbol="or()" data-astro-cid-mw7aashj> <a href="#or" data-astro-cid-mw7aashj>or()</a> </li><li data-api-symbol="orderby()" data-astro-cid-mw7aashj> <a href="#orderby" data-astro-cid-mw7aashj>orderBy()</a> </li><li data-api-symbol="ownclientuntilpagehide()" data-astro-cid-mw7aashj> <a href="#ownclientuntilpagehide" data-astro-cid-mw7aashj>ownClientUntilPagehide()</a> </li><li data-api-symbol="preflightworkerepochstorage()" data-astro-cid-mw7aashj> <a href="#preflightworkerepochstorage" data-astro-cid-mw7aashj>preflightWorkerEpochStorage()</a> </li><li data-api-symbol="query()" data-astro-cid-mw7aashj> <a href="#query" data-astro-cid-mw7aashj>query()</a> </li><li data-api-symbol="readpyricruntimemanifest()" data-astro-cid-mw7aashj> <a href="#readpyricruntimemanifest" data-astro-cid-mw7aashj>readPyricRuntimeManifest()</a> </li><li data-api-symbol="ref()" data-astro-cid-mw7aashj> <a href="#ref" data-astro-cid-mw7aashj>ref()</a> </li><li data-api-symbol="relayworkerop()" data-astro-cid-mw7aashj> <a href="#relayworkerop" data-astro-cid-mw7aashj>relayWorkerOp()</a> </li><li data-api-symbol="relayworkersub()" data-astro-cid-mw7aashj> <a href="#relayworkersub" data-astro-cid-mw7aashj>relayWorkerSub()</a> </li><li data-api-symbol="rememberworkerepoch()" data-astro-cid-mw7aashj> <a href="#rememberworkerepoch" data-astro-cid-mw7aashj>rememberWorkerEpoch()</a> </li><li data-api-symbol="resetall()" data-astro-cid-mw7aashj> <a href="#resetall" data-astro-cid-mw7aashj>resetAll()</a> </li><li data-api-symbol="retireworkerruntime()" data-astro-cid-mw7aashj> <a href="#retireworkerruntime" data-astro-cid-mw7aashj>retireWorkerRuntime()</a> </li><li data-api-symbol="rtdbchild()" data-astro-cid-mw7aashj> <a href="#rtdbchild" data-astro-cid-mw7aashj>rtdbChild()</a> </li><li data-api-symbol="rtdbconnectdatabaseemulator()" data-astro-cid-mw7aashj> <a href="#rtdbconnectdatabaseemulator" data-astro-cid-mw7aashj>rtdbConnectDatabaseEmulator()</a> </li><li data-api-symbol="rtdbget()" data-astro-cid-mw7aashj> <a href="#rtdbget" data-astro-cid-mw7aashj>rtdbGet()</a> </li><li data-api-symbol="rtdbgetdatabase()" data-astro-cid-mw7aashj> <a href="#rtdbgetdatabase" data-astro-cid-mw7aashj>rtdbGetDatabase()</a> </li><li data-api-symbol="rtdbgooffline()" data-astro-cid-mw7aashj> <a href="#rtdbgooffline" data-astro-cid-mw7aashj>rtdbGoOffline()</a> </li><li data-api-symbol="rtdbgoonline()" data-astro-cid-mw7aashj> <a href="#rtdbgoonline" data-astro-cid-mw7aashj>rtdbGoOnline()</a> </li><li data-api-symbol="rtdboff()" data-astro-cid-mw7aashj> <a href="#rtdboff" data-astro-cid-mw7aashj>rtdbOff()</a> </li><li data-api-symbol="rtdbonchildadded()" data-astro-cid-mw7aashj> <a href="#rtdbonchildadded" data-astro-cid-mw7aashj>rtdbOnChildAdded()</a> </li><li data-api-symbol="rtdbonchildchanged()" data-astro-cid-mw7aashj> <a href="#rtdbonchildchanged" data-astro-cid-mw7aashj>rtdbOnChildChanged()</a> </li><li data-api-symbol="rtdbonchildmoved()" data-astro-cid-mw7aashj> <a href="#rtdbonchildmoved" data-astro-cid-mw7aashj>rtdbOnChildMoved()</a> </li><li data-api-symbol="rtdbonchildremoved()" data-astro-cid-mw7aashj> <a href="#rtdbonchildremoved" data-astro-cid-mw7aashj>rtdbOnChildRemoved()</a> </li><li data-api-symbol="rtdbondisconnect()" data-astro-cid-mw7aashj> <a href="#rtdbondisconnect-1" data-astro-cid-mw7aashj>rtdbOnDisconnect()</a> </li><li data-api-symbol="rtdbonvalue()" data-astro-cid-mw7aashj> <a href="#rtdbonvalue" data-astro-cid-mw7aashj>rtdbOnValue()</a> </li><li data-api-symbol="rtdbpush()" data-astro-cid-mw7aashj> <a href="#rtdbpush" data-astro-cid-mw7aashj>rtdbPush()</a> </li><li data-api-symbol="rtdbref()" data-astro-cid-mw7aashj> <a href="#rtdbref" data-astro-cid-mw7aashj>rtdbRef()</a> </li><li data-api-symbol="rtdbremove()" data-astro-cid-mw7aashj> <a href="#rtdbremove" data-astro-cid-mw7aashj>rtdbRemove()</a> </li><li data-api-symbol="rtdbruntransaction()" data-astro-cid-mw7aashj> <a href="#rtdbruntransaction" data-astro-cid-mw7aashj>rtdbRunTransaction()</a> </li><li data-api-symbol="rtdbservertimestamp()" data-astro-cid-mw7aashj> <a href="#rtdbservertimestamp" data-astro-cid-mw7aashj>rtdbServerTimestamp()</a> </li><li data-api-symbol="rtdbset()" data-astro-cid-mw7aashj> <a href="#rtdbset" data-astro-cid-mw7aashj>rtdbSet()</a> </li><li data-api-symbol="rtdbsetpriority()" data-astro-cid-mw7aashj> <a href="#rtdbsetpriority" data-astro-cid-mw7aashj>rtdbSetPriority()</a> </li><li data-api-symbol="rtdbsetwithpriority()" data-astro-cid-mw7aashj> <a href="#rtdbsetwithpriority" data-astro-cid-mw7aashj>rtdbSetWithPriority()</a> </li><li data-api-symbol="rtdbupdate()" data-astro-cid-mw7aashj> <a href="#rtdbupdate" data-astro-cid-mw7aashj>rtdbUpdate()</a> </li><li data-api-symbol="runtransaction()" data-astro-cid-mw7aashj> <a href="#runtransaction" data-astro-cid-mw7aashj>runTransaction()</a> </li> </ul> </section><section class="api-symbol-group" data-api-symbol-group data-astro-cid-mw7aashj> <a class="api-symbol-kind" href="#multi-tab-correctness--read-set-validation--retry" data-astro-cid-mw7aashj> MULTI-TAB CORRECTNESS — READ-SET VALIDATION + RETRY </a> <ul data-astro-cid-mw7aashj> <li data-api-symbol="saveworkerbranch()" data-astro-cid-mw7aashj> <a href="#saveworkerbranch" data-astro-cid-mw7aashj>saveWorkerBranch()</a> </li><li data-api-symbol="servertimestamp()" data-astro-cid-mw7aashj> <a href="#servertimestamp" data-astro-cid-mw7aashj>serverTimestamp()</a> </li><li data-api-symbol="setdatabaserules()" data-astro-cid-mw7aashj> <a href="#setdatabaserules" data-astro-cid-mw7aashj>setDatabaseRules()</a> </li><li data-api-symbol="setdoc()" data-astro-cid-mw7aashj> <a href="#setdoc" data-astro-cid-mw7aashj>setDoc()</a> </li><li data-api-symbol="setfirestorerules()" data-astro-cid-mw7aashj> <a href="#setfirestorerules" data-astro-cid-mw7aashj>setFirestoreRules()</a> </li><li data-api-symbol="setlens()" data-astro-cid-mw7aashj> <a href="#setlens" data-astro-cid-mw7aashj>setLens()</a> </li><li data-api-symbol="setopissuer()" data-astro-cid-mw7aashj> <a href="#setopissuer" data-astro-cid-mw7aashj>setOpIssuer()</a> </li><li data-api-symbol="setpersistence()" data-astro-cid-mw7aashj> <a href="#setpersistence" data-astro-cid-mw7aashj>setPersistence()</a> </li><li data-api-symbol="setproviderconfig()" data-astro-cid-mw7aashj> <a href="#setproviderconfig" data-astro-cid-mw7aashj>setProviderConfig()</a> </li><li data-api-symbol="setrules()" data-astro-cid-mw7aashj> <a href="#setrules" data-astro-cid-mw7aashj>setRules()</a> </li><li data-api-symbol="signinanonymously()" data-astro-cid-mw7aashj> <a href="#signinanonymously" data-astro-cid-mw7aashj>signInAnonymously()</a> </li><li data-api-symbol="signinwithemailandpassword()" data-astro-cid-mw7aashj> <a href="#signinwithemailandpassword" data-astro-cid-mw7aashj>signInWithEmailAndPassword()</a> </li><li data-api-symbol="signout()" data-astro-cid-mw7aashj> <a href="#signout" data-astro-cid-mw7aashj>signOut()</a> </li><li data-api-symbol="startafter()" data-astro-cid-mw7aashj> <a href="#startafter" data-astro-cid-mw7aashj>startAfter()</a> </li><li data-api-symbol="startat()" data-astro-cid-mw7aashj> <a href="#startat" data-astro-cid-mw7aashj>startAt()</a> </li><li data-api-symbol="startpresence()" data-astro-cid-mw7aashj> <a href="#startpresence" data-astro-cid-mw7aashj>startPresence()</a> </li><li data-api-symbol="subscribeevents()" data-astro-cid-mw7aashj> <a href="#subscribeevents" data-astro-cid-mw7aashj>subscribeEvents()</a> </li><li data-api-symbol="subscribelens()" data-astro-cid-mw7aashj> <a href="#subscribelens" data-astro-cid-mw7aashj>subscribeLens()</a> </li><li data-api-symbol="subscribepresence()" data-astro-cid-mw7aashj> <a href="#subscribepresence" data-astro-cid-mw7aashj>subscribePresence()</a> </li><li data-api-symbol="sum()" data-astro-cid-mw7aashj> <a href="#sum" data-astro-cid-mw7aashj>sum()</a> </li><li data-api-symbol="switchworkerbranch()" data-astro-cid-mw7aashj> <a href="#switchworkerbranch" data-astro-cid-mw7aashj>switchWorkerBranch()</a> </li><li data-api-symbol="updatedoc()" data-astro-cid-mw7aashj> <a href="#updatedoc" data-astro-cid-mw7aashj>updateDoc()</a> </li><li data-api-symbol="uploadbytes()" data-astro-cid-mw7aashj> <a href="#uploadbytes" data-astro-cid-mw7aashj>uploadBytes()</a> </li><li data-api-symbol="uploadbytesresumable()" data-astro-cid-mw7aashj> <a href="#uploadbytesresumable" data-astro-cid-mw7aashj>uploadBytesResumable()</a> </li><li data-api-symbol="uploadstring()" data-astro-cid-mw7aashj> <a href="#uploadstring" data-astro-cid-mw7aashj>uploadString()</a> </li><li data-api-symbol="where()" data-astro-cid-mw7aashj> <a href="#where" data-astro-cid-mw7aashj>where()</a> </li><li data-api-symbol="workernameforepoch()" data-astro-cid-mw7aashj> <a href="#workernameforepoch" data-astro-cid-mw7aashj>workerNameForEpoch()</a> </li><li data-api-symbol="writebatch()" data-astro-cid-mw7aashj> <a href="#writebatch" data-astro-cid-mw7aashj>writeBatch()</a> </li> </ul> </section> <p class="api-symbol-empty" data-api-symbol-empty hidden data-astro-cid-mw7aashj>No matching symbols</p> </div> </aside> </div> <script type="module">const a=document.querySelector("[data-api-symbol-filter]"),d=[...document.querySelectorAll("[data-api-symbol-group]")],n=document.querySelector("[data-api-symbol-empty]");a?.addEventListener("input",()=>{const t=a.value.trim().toLowerCase();let o=0;for(const i of d){let e=0;i.querySelectorAll("[data-api-symbol]").forEach(l=>{const r=!t||(l.dataset.apiSymbol??"").includes(t);l.hidden=!r,r&&e++}),i.hidden=e===0,o+=e}n&&(n.hidden=o>0)});</script> <script type="module">const s=new Map;document.querySelectorAll('.doc-toc a[href^="#"]').forEach(t=>s.set(decodeURIComponent(t.hash.slice(1)),t));if(s.size>0){const t=new Set,n=()=>{let o=null;for(const e of s.keys())if(t.has(e)){o=e;break}s.forEach((e,c)=>e.classList.toggle("active",c===o))},r=new IntersectionObserver(o=>{for(const e of o)e.isIntersecting?t.add(e.target.id):t.delete(e.target.id);n()},{rootMargin:"-72px 0px -60% 0px"});s.forEach((o,e)=>{const c=document.getElementById(e);c&&r.observe(c)})}</script> <script type="module">document.querySelector('.studio__nav [aria-current="page"]')?.scrollIntoView({block:"nearest",inline:"center"});</script> </body></html>
|