Optionaloptions: DistanceDisplayUnits
The display units, including their type and custom ways to display them.
const metric = { type: 'metric' } as const;
formatDistance(undefined, metric); // ""
formatDistance(0, metric); // "0 m"
formatDistance(2, metric); // "2 m"
formatDistance(7.348, metric); // "7.3 m"
formatDistance(237, metric); // "240 m"
formatDistance(730, metric); // "700 m"
formatDistance(950, metric); // "1 km"
formatDistance(-999, metric); // "-1 km"
formatDistance(2850, metric); // "2.9 km"
formatDistance(283520, metric); // "284 km"
const us = { type: 'imperial_us' } as const;
formatDistance(2, us); // "7 ft"
formatDistance(100, us); // "330 ft"
formatDistance(182.88, us); // "600 ft"
formatDistance(205.95, us); // "¼ mi"
formatDistance(1205.95, us); // "¾ mi"
formatDistance(5309.7, us); // "3½ mi"
formatDistance(-18181.7, us); // "-11 mi"
const uk = { type: 'imperial_uk' } as const;
formatDistance(2, uk); // "2 yd"
formatDistance(150.88, uk); // "170 yd"
formatDistance(4344.3, uk); // "2¾ mi"
formatDistance(21753.68, uk); // "14 mi"
Formats a distance in meters for display, by unit type. Fewer meters give more precision.