Skip to content

SyncPage — @gj-kit/expo-workouts

A public interface from @gj-kit/expo-workouts/core. The signature below is taken directly from the 0.1.1 release declaration.

import { SyncPage } from '@gj-kit/expo-workouts/core';
interface SyncPage {
/**
* An idempotent UPSERT SET keyed by `id` (or by `clientId` for own writes), never a delta append.
* The same workout may legitimately appear in two consecutive results. Health Connect emits an
* upsertion change even for a write that changed nothing, so the presence of a workout here is not
* a claim that it changed.
*/
readonly added: readonly Workout[];
/** May contain ids this app never held. `remove(unknown id)` MUST be a no-op. */
readonly removed: readonly RemovedWorkout[];
/**
* Persist this together with `added`/`removed` **IN ONE TRANSACTION**. Persisting the cursor
* without the items loses those workouts permanently and the library cannot prevent it.
*/
readonly cursor: WorkoutsSyncCursor;
/** `true` = call `syncWorkouts(result.cursor)` again immediately. */
readonly hasMore: boolean;
}

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

  • Package: @gj-kit/expo-workouts
  • Version: 0.1.1
  • Public entry: ./core
  • Source: GitHub