Class: SyncSchemaMismatchError

Defined in: packages/client/src/core/sync/index.ts:148

Raised when a remote is ahead of this device's data model.

Pulling from it would deliver documents shaped by patches this device has not applied; they would be stored verbatim (replication writes bypass validation, by design) and then fail to read back. Refusing early leaves the local stack intact and tells the application to ship the newer build.

Extends

• Error

Constructors

Constructor

new SyncSchemaMismatchError(
   stack, 
   localVersion, 
   remoteVersion, 
   scope): SyncSchemaMismatchError;

Defined in: packages/client/src/core/sync/index.ts:160

Parameters

Parameter	Type	Default value
stack	string	undefined
localVersion	string	undefined
remoteVersion	string	undefined
scope	"system" | "consumer"	"system"

Returns

SyncSchemaMismatchError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Defined in
localVersion	readonly	string	undefined	The schema version this device has applied, if any.	-	packages/client/src/core/sync/index.ts:153
name	public	string	"SyncSchemaMismatchError"	-	Error.name	packages/client/src/core/sync/index.ts:149
remoteVersion	readonly	string	undefined	The schema version the remote was last written with.	-	packages/client/src/core/sync/index.ts:155
scope	readonly	"system" | "consumer"	undefined	Which half of the gate refused: the system schema, or the application's consumer patches.	-	packages/client/src/core/sync/index.ts:158
stack	readonly	string	undefined	The stack that refused to sync.	Error.stack	packages/client/src/core/sync/index.ts:151