Skip to content

corruptCursor — @gj-kit/expo-workouts

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

import { corruptCursor } from '@gj-kit/expo-workouts/testing';
/**
* Produce a cursor that forces one specific `CursorResetReason`, so a test can reach all SIX
* without hand-rolling cursor strings. Three of them (`expired`, `scopesChanged`, `noCursor`) are
* facts about the store or the call rather than about the string — for those this returns the
* cursor unchanged (`null` for `noCursor`) and `expireCursor()` is the control that produces them.
*/
declare function corruptCursor(cursor: WorkoutsSyncCursor, reason: CursorResetReason): WorkoutsSyncCursor | null;

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: ./testing
  • Source: GitHub