entity_sync library

Classes

BoolField
Represents a boolean field which may be serialized
DateTimeField
Represents an datetime field which may be serialized
Endpoint<TSyncable extends SyncableMixin>
Represents an entity endpoint Responsible for pulling & pushing entities
EndpointResult<TSyncable extends SyncableMixin>
Represents the result of an operation with an endpoint
IntegerField
Represents an integer field which may be serialized
RestfulApiEndpoint<TSyncable extends SyncableMixin>
Represents a restful api endpoint
SerializableField
Represents a field which may be serialized
SerializableMixin
Added to a class to support serialization
Serializer<TSerializable extends SerializableMixin>
Performs serialization
Storage<TSyncable extends SyncableMixin>
Responsible for local storage of syncable entities
StorageResult<TSyncable extends SyncableMixin>
StringField
Represents an string field which may be serialized
SyncableMixin
Added to a class to support syncing Syncable classes also must be serializable
SyncController<TSyncable extends SyncableMixin>
Responsible for controlling the syncing of entities
SyncResult<TSyncable extends SyncableMixin>
Represents the result of a sync operation

Exceptions / Errors

ValidationException
An exception which represents a failed validation