Sync / foldkit-sync/remote

RemoteOverlays

interface · packages/sync/src/remote.ts:26

interface RemoteOverlays<AppModel> {
  readonly store: {
    get(model: AppModel): RemoteModel
  }
  overlay(
    model: AppModel,
    id: string,
    optimistic: ReadonlyArray<OptimisticOperation>,
  ): AppModel
  lift(model: AppModel, id: string): AppModel
  overlays(model: AppModel): ReadonlyArray<string>
}

What RemoteEdits.make uses of a Remote domain: Remote.make's value is one.

Members

RemoteOverlays.store

property · packages/sync/src/remote.ts:27

readonly store: {
  get(model: AppModel): RemoteModel
}

RemoteOverlays.overlay

method · packages/sync/src/remote.ts:28

overlay(
  model: AppModel,
  id: string,
  optimistic: ReadonlyArray<OptimisticOperation>,
): AppModel

RemoteOverlays.lift

method · packages/sync/src/remote.ts:29

lift(model: AppModel, id: string): AppModel

RemoteOverlays.overlays

method · packages/sync/src/remote.ts:30

overlays(model: AppModel): ReadonlyArray<string>