Reference

Complete API documentation, CLI commands, and type definitions.

Server API

Core Functions

• registerSyncRoutes() - Register sync endpoints
• PrismaAdapter() - Create Prisma database adapter

Interfaces

• DatabaseAdapter - Database adapter interface
• SyncServerOptions - Configuration options

Helpers

• createJWTAuth() - JWT authentication helper
• makeRedisBroadcaster() - Redis broadcasting

Client API

Core Functions

• createSyncClient() - Initialize sync client
• warmUpModelRegistry() - Pre-register models

Store API

• Store - Core store class
• store.init() - Initialize store
• store.save() - Save mutations
• store.create() - Create records
• store.remove() - Delete records

React Hooks

• useModel() - Get single model
• useCollectionModels() - Get collection
• useConnectionState() - Connection status
• useStore() - Access store
• useGraphBridge() - Access graph bridge

Model Decorators

• @ClientModel() - Define model type
• @Property() - Define property
• @ManyToOne() - Many-to-one relationship
• @OneToMany() - One-to-many relationship

Classes

• Model - Base model class
• LazyReference - Lazy single relationship
• LazyCollection - Lazy collection relationship
• GraphBridge - Identity mapping layer

Types

• Wire Format Types - WireRow, SyncFrame
• Configuration Types - Config interfaces
• Adapter Types - Adapter interfaces