Skip to content
0

katanakit-js / useToMiles

Function: useToMiles() ​

ts
function useToMiles(
   km, 
   locale?, 
   digits?
): string;

Defined in: src/core/services/formatter.service.ts:262

Pure: kilometers → miles (formatted). Round-trips with useToKilometers.

Parameters ​

ParameterTypeDefault valueDescription
kmnumberundefinedDistance in kilometers.
locale"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh""en"BCP 47 locale tag. Defaults to "en".
digitsnumber2Fraction digits. Defaults to 2.

Returns ​

string

The formatted mile string.

Example ​

ts
import { useToMiles } from "katanakit-js";

useToMiles(1.60934); // "1.00"

Released under the MIT License.