Client API Reference

Complete API documentation for @gluonic/client and client-side packages.

Core

• SyncClient - Create sync client
• SyncProvider - React provider component
• StoreOptions - Store configuration options

Adapters

Storage

• StorageAdapter - Local storage interface
• DrizzleAdapter - Drizzle implementation (currently supported)

Planned:

• RxDBAdapter - RxDB storage adapter (future release)

Server Communication

• MutationAdapter - Mutation requests to server
• BatchLoaderAdapter - Batch loading from server
• DownsyncAdapter - Delta sync and bootstrap
• RealtimeAdapter - WebSocket real-time updates

Model System

• Model - Base model class
• Decorators - @ClientModel, @Property, @ManyToOne, @OneToMany
• Reference - Eager reference class
• LazyReference - Lazy-loading reference
• Collection - Eager collection class
• LazyCollection - Lazy-loading collection

Hooks

• useModel - Get single model
• useCollectionModels - Get model collection
• useStore - Access store for mutations
• useConnectionState - Monitor sync status
• observer - MobX observer HOC (re-exported)

Core Types

• WireRow - Row data format used in ObjectPool
• SyncFrame - Sync protocol frame format

Advanced

• IdentityMap - Identity mapping and caching
• Store Methods - Low-level store API