Skip to main content
Version: 0.17

Interface: Syncable<O, TransformBuilder>

A source decorated as @syncable must also implement the Syncable interface.

Type parameters

NameType
Oextends Operation
TransformBuilderTransformBuilder

Methods

_sync

_sync(transform): Promise<void>

Parameters

NameType
transformTransform<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 Transforms as an argument and applies it to the source.

Parameters

NameType
transformOrTransformsTransform<O> | Transform<O>[] | TransformBuilderFunc<O, TransformBuilder>

Returns

Promise<void>

Defined in

packages/@orbit/data/src/source-interfaces/syncable.ts:27