@gj-kit/expo-workouts API

This reference is generated from the 0.1.1 release declaration snapshot. Unpublished main APIs are not shown.

`Root entry`

Import: @gj-kit/expo-workouts

Symbol	Kind
`activeDurationS`	function
`ANDROID_HISTORY_PERMISSION`	constant
`ANDROID_HISTORY_WINDOW_MS`	constant
`ANDROID_READ_PERMISSIONS`	constant
`ANDROID_WRITE_PERMISSIONS`	constant
`androidExerciseTypeFromKind`	function
`androidRequestPermissions`	function
`androidRuntimeRequestPermissions`	function
`AndroidWorkout`	interface
`AndroidWorkoutData`	interface
`assertNeverWorkoutsCode`	function
`authorizationAdvice`	function
`AuthorizationAdvice`	type
`AuthorizationDerivationFacts`	interface
`AuthorizationFacts`	interface
`AuthorizationRequest`	interface
`AuthorizationResult`	type
`AuthorizationSnapshotDto`	interface
`AuthorizationState`	type
`Availability`	type
`AvailabilityDto`	type
`collectRoute`	function
`createWorkoutsApi`	function
`CreateWorkoutsApiOptions`	interface
`CURSOR_FORMAT_VERSION`	constant
`CursorInfo`	interface
`CursorResetReason`	type
`DeleteRefDto`	interface
`DeleteResult`	interface
`deleteWorkout`	constant
`deniedFromOutcome`	function
`deriveAuthorizationState`	function
`derivePauses`	function
`describeCursor`	function
`DirectedPermissions`	interface
`DrainBatchDto`	interface
`EPOCH_MS_FLOOR`	constant
`estimateAndroidRecordBytes`	function
`ExistingWorkoutDto`	interface
`getAuthorizationState`	constant
`getAvailability`	constant
`getRoute`	constant
`GetRouteOptions`	interface
`hasAndroidIndoorPair`	function
`HeartRateDto`	interface
`HeartRateSample`	interface
`HeartRateSummaryDto`	interface
`Interval`	interface
`IOS_SCOPE_TYPES`	constant
`iosActivityTypeFromKind`	function
`iosRequestIdentifiers`	function
`IosWorkout`	interface
`IosWorkoutData`	interface
`isWorkoutsError`	function
`kindFromAndroidExerciseType`	function
`kindFromIosActivityType`	function
`Lap`	interface
`LapDto`	interface
`ListQuery`	interface
`listWorkouts`	constant
`MAX_ANDROID_ROUTE_POINTS`	constant
`MAX_HEART_RATE_WINDOW_MS`	constant
`MetricProvenance`	type
`MetricRowDto`	interface
`MetricTypeDto`	type
`missingDeclarations`	function
`NATIVE_ERROR_CODES`	constant
`nativeErrorCodeFor`	function
`NativePayloadDto`	interface
`NativeWorkoutsModule`	interface
`normalizeRouteForWrite`	function
`openSettings`	constant
`openStoreListing`	constant
`Pause`	interface
`PauseDto`	interface
`PermissionOutcomeDto`	interface
`PermissionRequestDto`	interface
`QuantityKindDto`	type
`READABLE_CURSOR_VERSIONS`	constant
`ReadBudget`	class
`ReadBudgetOptions`	interface
`readHeartRate`	constant
`readSteps`	constant
`reconcileSyncPage`	function
`RemovedDto`	interface
`RemovedWorkout`	interface
`requestAuthorization`	constant
`requiredWriteScopes`	function
`RouteAccess`	type
`routeDistanceM`	function
`routeElevationGainM`	function
`RouteHandleDto`	interface
`RoutePoint`	interface
`RoutePointDto`	interface
`RouteState`	type
`RouteWriteOutcome`	type
`SaveOutcomeDto`	interface
`SaveResult`	type
`saveWorkout`	constant
`Scope`	type
`SCOPES`	constant
`ScopeStatus`	type
`SourceDto`	interface
`StepTotal`	interface
`SyncPage`	interface
`SyncResult`	type
`syncWorkouts`	constant
`TimeWindow`	interface
`unpopulatedWorkoutMetrics`	function
`WindowDto`	interface
`Workout`	type
`WORKOUT_KINDS`	constant
`WORKOUT_METRIC_SCOPES`	constant
`WORKOUT_TOTALS_SCOPES`	constant
`WorkoutBase`	interface
`WorkoutDto`	interface
`WorkoutHeartRateSummary`	interface
`WorkoutKind`	type
`WorkoutMetricField`	type
`WorkoutPage`	interface
`WorkoutPageDto`	interface
`WorkoutRef`	type
`workouts`	constant
`WORKOUTS_ERROR_CODES`	constant
`WorkoutsApi`	interface
`WorkoutsError`	class
`workoutsErrorCode`	function
`WorkoutsErrorCode`	type
`WorkoutsErrorOptions`	interface
`workoutsExceptionClassName`	function
`WorkoutSource`	interface
`WorkoutsPageToken`	type
`WorkoutsPlatform`	type
`WorkoutsSyncCursor`	type
`WorkoutWrite`	interface
`WorkoutWriteDto`	interface

`./core`

Import: @gj-kit/expo-workouts/core

Symbol	Kind
`activeDurationS`	function
`ANDROID_HISTORY_PERMISSION`	constant
`ANDROID_HISTORY_WINDOW_MS`	constant
`ANDROID_READ_PERMISSIONS`	constant
`ANDROID_WRITE_PERMISSIONS`	constant
`androidExerciseTypeFromKind`	function
`androidRequestPermissions`	function
`androidRuntimeRequestPermissions`	function
`AndroidWorkout`	interface
`AndroidWorkoutData`	interface
`assertNeverWorkoutsCode`	function
`authorizationAdvice`	function
`AuthorizationAdvice`	type
`AuthorizationDerivationFacts`	interface
`AuthorizationFacts`	interface
`AuthorizationRequest`	interface
`AuthorizationResult`	type
`AuthorizationSnapshotDto`	interface
`AuthorizationState`	type
`Availability`	type
`AvailabilityDto`	type
`collectRoute`	function
`createWorkoutsApi`	function
`CreateWorkoutsApiOptions`	interface
`CURSOR_FORMAT_VERSION`	constant
`CursorInfo`	interface
`CursorResetReason`	type
`DeleteRefDto`	interface
`DeleteResult`	interface
`deniedFromOutcome`	function
`deriveAuthorizationState`	function
`derivePauses`	function
`describeCursor`	function
`DirectedPermissions`	interface
`DrainBatchDto`	interface
`EPOCH_MS_FLOOR`	constant
`estimateAndroidRecordBytes`	function
`ExistingWorkoutDto`	interface
`GetRouteOptions`	interface
`hasAndroidIndoorPair`	function
`HeartRateDto`	interface
`HeartRateSample`	interface
`HeartRateSummaryDto`	interface
`Interval`	interface
`IOS_SCOPE_TYPES`	constant
`iosActivityTypeFromKind`	function
`iosRequestIdentifiers`	function
`IosWorkout`	interface
`IosWorkoutData`	interface
`isWorkoutsError`	function
`kindFromAndroidExerciseType`	function
`kindFromIosActivityType`	function
`Lap`	interface
`LapDto`	interface
`ListQuery`	interface
`MAX_ANDROID_ROUTE_POINTS`	constant
`MAX_HEART_RATE_WINDOW_MS`	constant
`MetricProvenance`	type
`MetricRowDto`	interface
`MetricTypeDto`	type
`missingDeclarations`	function
`NATIVE_ERROR_CODES`	constant
`nativeErrorCodeFor`	function
`NativePayloadDto`	interface
`NativeWorkoutsModule`	interface
`normalizeRouteForWrite`	function
`Pause`	interface
`PauseDto`	interface
`PermissionOutcomeDto`	interface
`PermissionRequestDto`	interface
`QuantityKindDto`	type
`READABLE_CURSOR_VERSIONS`	constant
`ReadBudget`	class
`ReadBudgetOptions`	interface
`reconcileSyncPage`	function
`RemovedDto`	interface
`RemovedWorkout`	interface
`requiredWriteScopes`	function
`RouteAccess`	type
`routeDistanceM`	function
`routeElevationGainM`	function
`RouteHandleDto`	interface
`RoutePoint`	interface
`RoutePointDto`	interface
`RouteState`	type
`RouteWriteOutcome`	type
`SaveOutcomeDto`	interface
`SaveResult`	type
`Scope`	type
`SCOPES`	constant
`ScopeStatus`	type
`SourceDto`	interface
`StepTotal`	interface
`SyncPage`	interface
`SyncResult`	type
`TimeWindow`	interface
`unpopulatedWorkoutMetrics`	function
`WindowDto`	interface
`Workout`	type
`WORKOUT_KINDS`	constant
`WORKOUT_METRIC_SCOPES`	constant
`WORKOUT_TOTALS_SCOPES`	constant
`WorkoutBase`	interface
`WorkoutDto`	interface
`WorkoutHeartRateSummary`	interface
`WorkoutKind`	type
`WorkoutMetricField`	type
`WorkoutPage`	interface
`WorkoutPageDto`	interface
`WorkoutRef`	type
`WORKOUTS_ERROR_CODES`	constant
`WorkoutsApi`	interface
`WorkoutsError`	class
`workoutsErrorCode`	function
`WorkoutsErrorCode`	type
`WorkoutsErrorOptions`	interface
`workoutsExceptionClassName`	function
`WorkoutSource`	interface
`WorkoutsPageToken`	type
`WorkoutsPlatform`	type
`WorkoutsSyncCursor`	type
`WorkoutWrite`	interface
`WorkoutWriteDto`	interface

`./plugin`

Import: @gj-kit/expo-workouts/plugin

Symbol	Kind
`GjKitWorkoutsPluginProps`	interface

`./testing`

Import: @gj-kit/expo-workouts/testing

Symbol	Kind
`corruptCursor`	function
`createFakeNativeWorkouts`	function
`createFakeWorkouts`	function
`drainSync`	function
`FakeNativeWorkouts`	interface
`FakePermissionOutcome`	type
`FakeScopeGrants`	interface
`FakeSeed`	interface
`FakeWorkoutInput`	interface
`FakeWorkouts`	interface