katanakit-js / IFormatterService

Interface: IFormatterService

Defined in: src/types/index.ts:540

Contract of the formatter facade.

Methods

useCapitalize()

useCapitalize(text, locale?): string;

Defined in: src/types/index.ts:541

Parameters

Parameter	Type
text	string
locale?	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"

Returns

string

---

useFormatCurrency()

useFormatCurrency(options): string;

Defined in: src/types/index.ts:542

Parameters

Parameter	Type	Description
options	{ amount: number; currency?: | "EUR" | "USD" | "GBP" | "JPY" | "CAD" | "MXN" | "CHF" | "AUD" | "BRL" | "CNY" | "ARS" | "COP" | "CLP"; locale?: "en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"; taxes?: number; }	-
options.amount	number	-
options.currency?	| "EUR" | "USD" | "GBP" | "JPY" | "CAD" | "MXN" | "CHF" | "AUD" | "BRL" | "CNY" | "ARS" | "COP" | "CLP"	-
options.locale?	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"	-
options.taxes?	number	Tax rate: percentage when > 1 (e.g. 21 → 21%), or decimal fraction when in (0, 1] (e.g. 0.21 → 21%). Prefer a fraction for rates ≤ 1%.

Returns

string

---

useFormatNumber()

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

Defined in: src/types/index.ts:543

Parameters

Parameter	Type
value	number
locale?	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"
digits?	number

Returns

string

---

useJsonParse()

useJsonParse<T>(json): T;

Defined in: src/types/index.ts:545

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
json	string

Returns

T

---

useJsonStringify()

useJsonStringify(data): string;

Defined in: src/types/index.ts:546

Parameters

Parameter	Type
data	unknown

Returns

string

---

useLowerCase()

useLowerCase(text, locale?): string;

Defined in: src/types/index.ts:547

Parameters

Parameter	Type
text	string
locale?	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"

Returns

string

---

useSalePrice()

useSalePrice(options): SalePrice;

Defined in: src/types/index.ts:544

Parameters

Parameter	Type	Description
options	{ discount: number; price: number; }	-
options.discount	number	Discount rate: percentage when > 1 (e.g. 40 → 40%), or decimal fraction when in (0, 1] (e.g. 0.4 → 40%). Same convention as taxes.
options.price	number	Regular price, before the discount.

Returns

SalePrice

---

useUpperCase()

useUpperCase(text, locale?): string;

Defined in: src/types/index.ts:548

Parameters

Parameter	Type
text	string
locale?	"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"

Returns

string