Skip to content

routeElevationGainM — @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.

import { routeElevationGainM } from '@gj-kit/expo-workouts/core';
/**
* Cumulative ascent, metres, with hysteresis: only rises of at least `minRiseM` count.
* Required on purpose — "what counts as a climb" differs between hiking and cycling apps and there
* is no defensible default.
*
* Points without `altM` are skipped; they neither break nor extend a rise.
*/
declare function routeElevationGainM(points: readonly RoutePoint[], minRiseM: number): number;

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