Function convertDistance

convertDistance(
    value: number,
    unit?: MeasureUnitType,
    forceUnit?: distanceUnitType,
    measureUnitSymbols?: MeasureUnitSymbolType,
): { distance: number; unit: string }
Convert distance according to the distance unit given.

Converts a distance in meters to the appropriate unit based on the unit and forceUnit parameters.
- For metric, it converts to km, m, or cm depending on the value and forceUnit.
- For imperial, it converts to mi, ft, or in depending on the value and forceUnit.
Parameters
- value: number
  The distance in meters.
- unit: MeasureUnitType = 'metric'
  The unit system for output: "metric" or "imperial" (default is 'metric').
- forceUnit: distanceUnitType = undefined
  Default is auto. If auto is set, the unit is converted automatically based on the value. If a specific unit is set, the value is converted to that unit.
- measureUnitSymbols: MeasureUnitSymbolType = defaultMeasureUnitSymbols
  Optional parameter to provide custom unit symbols
Returns { distance: number; unit: string }
The converted value and unit.
- Defined in helpers/convertDistance.ts:17