Decorators

Decorator reference for defining synced models, properties, and relations in Strata Sync.

Register metadata with the ModelRegistry at class definition time. The sync engine uses this for change tracking, serialization, delta processing, and schema hashing.

Enable decorators in tsconfig.json:


{
  "compilerOptions": {
    "experimentalDecorators": true
  }
}

Common options

Shared by several decorators. Individual sections reference this table.

Option	Type	Default	Description
`lazy`	`boolean`	`false`	Defers hydration until first access.
`serializer`	`PropertySerializer`	-	Custom serializer for converting values to and from their stored representation. See Custom serializers.

@ClientModel

Registers a synced model.

Decorators

Decorator reference for defining synced models, properties, and relations in Strata Sync.

Register metadata with the ModelRegistry at class definition time. The sync engine uses this for change tracking, serialization, delta processing, and schema hashing.

Enable decorators in tsconfig.json:


{
  "compilerOptions": {
    "experimentalDecorators": true
  }
}

Common options

Shared by several decorators. Individual sections reference this table.

Option	Type	Default	Description
`lazy`	`boolean`	`false`	Defers hydration until first access.
`serializer`	`PropertySerializer`	-	Custom serializer for converting values to and from their stored representation. See Custom serializers.

@ClientModel

Registers a synced model.

Option	Type	Default	Description
`loadStrategy`	`LoadStrategy`	`"instant"`	How and when the model data is fetched.
`partialLoadMode`	`PartialLoadMode`	-	Hydration priority for partial models.
`usedForPartialIndexes`	`boolean`	-	Whether this model is used for partial index dependencies.
`schemaVersion`	`number`	-	Schema version for migration tracking.
`tableName`	`string`	-	Database table name override.
`groupKey`	`string`	-	Sync-group key field for multi-tenancy.

Strategy	Behavior
`"instant"`	Loaded during bootstrap. Always available in memory.
`"lazy"`	Loaded on first access, cached thereafter.
`"partial"`	Loaded on demand, partially hydrated.
`"explicitlyRequested"`	Never auto-loaded. Must be explicitly requested via `ensureModel`.
`"local"`	Never synced. Only stored locally on the device.

Parameter	Description
`modelFactory`	Factory function returning the referenced model constructor. Uses a factory to avoid circular deps.
`inverseProperty`	Name of the inverse collection property on the referenced model (for example, `"tasks"` on `Project`).

Option	Type	Default	Description
`foreignKey`	`string`	`"<propertyName>Id"`	Override the foreign key field name.
`nullable`	`boolean`	-	Whether the reference can be null.
`indexed`	`boolean`	`true` (when `inverseProperty` is set)	Whether to index this foreign key.

Option	Type	Default	Description
`foreignKey`	`string`	-	Override the foreign key used for the collection lookup.
`indexed`	`boolean`	-	Whether the collection uses an index.
`nullable`	`boolean`	-	Whether the collection can be null.

Decorators

Common options

@ClientModel

Decorators

Common options

@ClientModel

ModelOptions

Load strategies

@Property

PropertyOptions

Custom serializers

@EphemeralProperty

@Reference

ReferenceOptions

Custom foreign key

@ManyToOne

@OneToMany

ReferenceCollectionOptions

Inverse side pairing

@BackReference

BackReferenceOptions

@ReferenceArray

ReferenceArrayOptions

@ReferenceCollection

Complete example