describeCursor — @gj-kit/expo-workouts

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

Verified import example

import { describeCursor } from '@gj-kit/expo-workouts/core';

Signature, parameters, and return type

/**
 * Inspect a cursor for diagnostics and progress UI. Returns `null` for anything this build cannot
 * read - it NEVER throws.
 *
 * It NEVER returns the platform token (HKQueryAnchor / Health Connect changes token): an app that
 * stores its cursor on a server would otherwise be storing the platform's own token. A guard test
 * asserts no substring of the encoded token appears in the returned object.
 */
declare function describeCursor(cursor: string): CursorInfo | 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.

Release context

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