katanakit-js / useFormatNumber

Function: useFormatNumber()

function useFormatNumber(
   value, 
   locale?, 
   digits?
): string;

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

Pure number formatter over Intl.NumberFormat. Stateless — safe to call from any environment.

Parameters

Parameter	Type	Default value	Description
value	number	undefined	The number to format.
locale	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"	"en"	BCP 47 locale tag. Defaults to "en".
digits	number	2	Maximum and minimum fraction digits. Defaults to 2.

Returns

string

The formatted number string.

Example

import { useFormatNumber } from "katanakit-js";

useFormatNumber(1234.5, "en", 2); // "1,234.50"
useFormatNumber(1234.5, "de", 2); // "1.234,50"