@syncular/client
v0.0.6-243
Published
Client-side sync engine with offline-first support, outbox, and conflict resolution
Maintainers
Readme
@syncular/client
Client-side sync engine for Syncular with offline-first support: local outbox, incremental push/pull, conflict detection, subscriptions/scopes, and optional blobs/plugins.
Install
npm install @syncular/clientDocumentation
- Client setup: https://syncular.dev/docs/build/client-setup
- Subscriptions (partial sync): https://syncular.dev/docs/introduction/subscriptions
- Commits & conflicts: https://syncular.dev/docs/introduction/commits
Notes
- Client subscriptions may declare
bootstrapPhaseto stage bootstrap work. Lower phases bootstrap first; later phases are deferred until earlier phases are ready, while already-ready subscriptions stay live. client.getBootstrapStatus()reports both the blocking phase readiness and the full per-phase bootstrap summary.traceEnabled: trueemits structuredsync:traceevents and records them in inspector snapshots for pull/apply diagnostics.
Links
- GitHub: https://github.com/syncular/syncular
- Issues: https://github.com/syncular/syncular/issues
Status: Alpha. APIs and storage layouts may change between releases.
