Skip to content

UnitConverterService

katanakit-js / UnitConverterService

Defined in: core/services/converter.service.ts:24

UnitConverterService — Singleton facade for physical unit conversions.

Applies the Singleton pattern (UnitConverterService.getInstance), the Facade pattern (one call per conversion) and Dependency Injection: it never formats numbers itself, it delegates to an injected IFormatterService. Swap that dependency through UnitConverterService.create or UnitConverterService.useSetFormatter.

Every conversion is pure and returns a formatted string; the underlying factors are instance state, never statics.

import { useToKilometers } from "katanakit-js";
useToKilometers(1); // "1.61"
useSetFormatter(formatter): void;

Defined in: core/services/converter.service.ts:71

Swaps the number formatter dependency at runtime (DI).

Parameter Type Description
formatter IFormatterService The new formatter to delegate to.

void


useToCelsius(
fahrenheit,
locale?,
digits?
): string;

Defined in: core/services/converter.service.ts:96

Pure: °F → °C (formatted).

Parameter Type Default value Description
fahrenheit number undefined Temperature in Fahrenheit.
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.

string

The formatted Celsius string.

import { useToCelsius } from "katanakit-js";
useToCelsius(212); // "100.00"
useToCelsius(32); // "0.00"

IConverterService.useToCelsius


useToCm(
inches,
locale?,
digits?
): string;

Defined in: core/services/converter.service.ts:192

Pure: inches → centimeters (formatted).

Parameter Type Default value Description
inches number undefined Length in inches.
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.

string

The formatted centimeter string.

import { useToCm } from "katanakit-js";
useToCm(1); // "2.54"

IConverterService.useToCm


useToFahrenheit(
celsius,
locale?,
digits?
): string;

Defined in: core/services/converter.service.ts:116

Pure: °C → °F (formatted).

Parameter Type Default value Description
celsius number undefined Temperature in Celsius.
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.

string

The formatted Fahrenheit string.

import { useToFahrenheit } from "katanakit-js";
useToFahrenheit(100); // "212.00"
useToFahrenheit(0); // "32.00"

IConverterService.useToFahrenheit


useToInches(
cm,
locale?,
digits?
): string;

Defined in: core/services/converter.service.ts:173

Pure: centimeters → inches (formatted).

Parameter Type Default value Description
cm number undefined Length in centimeters.
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.

string

The formatted inch string.

import { useToInches } from "katanakit-js";
useToInches(2.54); // "1.00"

IConverterService.useToInches


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

Defined in: core/services/converter.service.ts:135

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

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.

string

The formatted kilometer string.

import { useToKilometers } from "katanakit-js";
useToKilometers(1); // "1.61"

IConverterService.useToKilometers


useToKilos(
pounds,
locale?,
digits?
): string;

Defined in: core/services/converter.service.ts:211

Pure: pounds → kilograms (formatted).

Parameter Type Default value Description
pounds number undefined Weight in pounds.
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.

string

The formatted kilogram string.

import { useToKilos } from "katanakit-js";
useToKilos(1); // "0.45"

IConverterService.useToKilos


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

Defined in: core/services/converter.service.ts:154

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

Parameter Type Default value Description
km number undefined Distance in kilometers.
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.

string

The formatted mile string.

import { useToMiles } from "katanakit-js";
useToMiles(1.60934); // "1.00"

IConverterService.useToMiles


useToPounds(
kilos,
locale?,
digits?
): string;

Defined in: core/services/converter.service.ts:230

Pure: kilograms → pounds (formatted).

Parameter Type Default value Description
kilos number undefined Weight in kilograms.
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.

string

The formatted pound string.

import { useToPounds } from "katanakit-js";
useToPounds(1); // "2.20"

IConverterService.useToPounds


static create(formatter?): UnitConverterService;

Defined in: core/services/converter.service.ts:62

Creates a NO-singleton instance with an injected formatter (DI). Useful for tests or for custom number formatting.

Parameter Type Description
formatter? IFormatterService Formatter to inject. Defaults to FormatterService.

UnitConverterService

A new UnitConverterService.

const converter = UnitConverterService.create(myFormatter);

static getInstance(): UnitConverterService;

Defined in: core/services/converter.service.ts:43

Returns the shared instance (Singleton).

UnitConverterService