Skip to main content

formatDistance

FitFileViewer - API Documentation v29.9.0

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

Function: formatDistance()

formatDistance(meters: number): string

Defined in: utils/formatting/formatters/formatDistance.js:36

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

Converts the input distance to both metric (kilometers) and imperial (miles) units and returns a formatted string. Invalid inputs (negative, zero, NaN, or non-finite numbers) return an empty string.

Parameters​

meters​

number

The distance in meters to format. Must be a finite positive number.

Returns​

string

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

Example​

formatDistance(1000); // "1.00 km / 0.62 mi"
    formatDistance(5000); // "5.00 km / 3.11 mi"
    formatDistance(-100); // ""
    formatDistance(NaN); // ""