Skip to content

GetRouteOptions — @gj-kit/expo-workouts

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

import { GetRouteOptions } from '@gj-kit/expo-workouts';
interface GetRouteOptions {
/**
* What to do when `routeState === 'consentRequired'` (Android only — HealthKit has no per-route
* consent).
* - `'skip'` (default) — throw `consentRequired`. Never shows UI, never blocks.
* - `'prompt'` — show the platform's per-route dialog and, if the user allows, stream the
* route from that same call. Can block for tens of seconds, so it must be driven by an explicit
* user gesture. Only one prompt may be in flight per process; a concurrent call throws `busy`.
*/
readonly consent?: 'skip' | 'prompt' | undefined;
}

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