pgxsinkit/pgxsinkit

core

Load when writing or reviewing code that uses @pgxsinkit/* — the offline-first sync toolkit for the Postgres -> Circuits engine -> durable-streams -> PGlite read path and the client -> write API -> Postgres write path. Teaches the model the source does not…

لغة النص الأصلي: الإنجليزية

operating

Load when deploying or operating a pgxsinkit app, when a sync/write "feels slow" in a browser but the server is fast, or when wiring backups/export/restore. Covers the runtime/deployment properties (not toolkit bugs) deciding whether an app feels fast:…

لغة النص الأصلي: الإنجليزية

registry-authoring

Load when defining or changing a pgxsinkit sync registry with @pgxsinkit/contracts — defineSyncRegistry/defineSyncTable, sync modes, managed fields, conflict policy, filters, RLS. Teaches the rules that throw or fail closed: every readwrite table needs a…

لغة النص الأصلي: الإنجليزية

operating

Load when wiring @pgxsinkit/pglite-opfs-repacked into a browser worker, choosing a worker scope, choosing relaxed or strict durability, handling store-open failures, or deleting and recreating a store after a format identity change. Covers the factory-only…

لغة النص الأصلي: الإنجليزية

react

Load when wiring @pgxsinkit/react into a React app — createSyncClientHooks and the reactive read hooks (useLiveRows, useLiveRow, useLiveDrizzleRows, useLiveDrizzleRow) plus SyncClientProvider / useSyncClient. Teaches that live reads are event-driven off…

لغة النص الأصلي: الإنجليزية

deploying

Load when deploying the @pgxsinkit/server write API, the read path's control plane, and the stream edge onto Bun, Deno, Supabase Edge Functions, or Cloudflare Workers. Covers the runtime-portable fetch handler, the three steps a non-Bun edge runtime needs…

لغة النص الأصلي: الإنجليزية