Interface: Syncable<O, TransformBuilder>
A source decorated as @syncable
must also implement the Syncable
interface.
Type parameters​
Name | Type |
---|---|
O | extends Operation |
TransformBuilder | TransformBuilder |
Methods​
_sync​
â–¸ _sync(transform
): Promise
<void
>
Parameters​
Name | Type |
---|---|
transform | Transform <O > |
Returns​
Promise
<void
>
Defined in​
packages/@orbit/data/src/source-interfaces/syncable.ts:34
sync​
â–¸ sync(transformOrTransforms
): Promise
<void
>
The sync
method to a source. This method accepts a Transform
or array
of Transform
s as an argument and applies it to the source.
Parameters​
Name | Type |
---|---|
transformOrTransforms | Transform <O > | Transform <O >[] | TransformBuilderFunc <O , TransformBuilder > |
Returns​
Promise
<void
>