katanakit-js / useToKilometers

Function: useToKilometers()

function useToKilometers(
   miles, 
   locale?, 
   digits?
): string;

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

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

Parameters

Parameter	Type	Default value	Description
miles	number	undefined	Distance in miles.
locale	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"	"en"	BCP 47 locale tag. Defaults to "en".
digits	number	2	Fraction digits. Defaults to 2.

Returns

string

The formatted kilometer string.

Example

import { useToKilometers } from "katanakit-js";

useToKilometers(1); // "1.61"