Skip to main content

formatDistance

FitFileViewer - API Documentation v30.0.1

FitFileViewer - API Documentation / utils/formatting/formatters/formatDistance / formatDistance

Function: formatDistance()

formatDistance(meters: unknown): string

Defined in: utils/formatting/formatters/formatDistance.ts:20

Formats a distance in meters to a string showing both kilometers and miles.

Invalid inputs (negative, zero, NaN, or non-finite numbers) return an empty string for compatibility with existing display code.

Parameters​

meters​

unknown

The distance in meters to format.

Returns​

string

The formatted distance as "X.XX km / Y.YY mi", or an empty string.

Example​

FormatDistance(1000); // "1.00 km / 0.62 mi" formatDistance(5000);
// "5.00 km / 3.11 mi"