UnitConverterService
katanakit-js / UnitConverterService
Class: UnitConverterService
Section titled “Class: 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.
Example
Section titled “Example”import { useToKilometers } from "katanakit-js";
useToKilometers(1); // "1.61"Implements
Section titled “Implements”Methods
Section titled “Methods”useSetFormatter()
Section titled “useSetFormatter()”useSetFormatter(formatter): void;Defined in: core/services/converter.service.ts:71
Swaps the number formatter dependency at runtime (DI).
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
formatter |
IFormatterService |
The new formatter to delegate to. |
Returns
Section titled “Returns”void
useToCelsius()
Section titled “useToCelsius()”useToCelsius( fahrenheit, locale?, digits?): string;Defined in: core/services/converter.service.ts:96
Pure: °F → °C (formatted).
Parameters
Section titled “Parameters”| 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. |
Returns
Section titled “Returns”string
The formatted Celsius string.
Example
Section titled “Example”import { useToCelsius } from "katanakit-js";
useToCelsius(212); // "100.00"useToCelsius(32); // "0.00"Implementation of
Section titled “Implementation of”IConverterService.useToCelsius
useToCm()
Section titled “useToCm()”useToCm( inches, locale?, digits?): string;Defined in: core/services/converter.service.ts:192
Pure: inches → centimeters (formatted).
Parameters
Section titled “Parameters”| 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. |
Returns
Section titled “Returns”string
The formatted centimeter string.
Example
Section titled “Example”import { useToCm } from "katanakit-js";
useToCm(1); // "2.54"Implementation of
Section titled “Implementation of”useToFahrenheit()
Section titled “useToFahrenheit()”useToFahrenheit( celsius, locale?, digits?): string;Defined in: core/services/converter.service.ts:116
Pure: °C → °F (formatted).
Parameters
Section titled “Parameters”| 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. |
Returns
Section titled “Returns”string
The formatted Fahrenheit string.
Example
Section titled “Example”import { useToFahrenheit } from "katanakit-js";
useToFahrenheit(100); // "212.00"useToFahrenheit(0); // "32.00"Implementation of
Section titled “Implementation of”IConverterService.useToFahrenheit
useToInches()
Section titled “useToInches()”useToInches( cm, locale?, digits?): string;Defined in: core/services/converter.service.ts:173
Pure: centimeters → inches (formatted).
Parameters
Section titled “Parameters”| 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. |
Returns
Section titled “Returns”string
The formatted inch string.
Example
Section titled “Example”import { useToInches } from "katanakit-js";
useToInches(2.54); // "1.00"Implementation of
Section titled “Implementation of”useToKilometers()
Section titled “useToKilometers()”useToKilometers( miles, locale?, digits?): string;Defined in: core/services/converter.service.ts:135
Pure: miles → kilometers (formatted). Round-trips with UnitConverterService.useToMiles.
Parameters
Section titled “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
Section titled “Returns”string
The formatted kilometer string.
Example
Section titled “Example”import { useToKilometers } from "katanakit-js";
useToKilometers(1); // "1.61"Implementation of
Section titled “Implementation of”IConverterService.useToKilometers
useToKilos()
Section titled “useToKilos()”useToKilos( pounds, locale?, digits?): string;Defined in: core/services/converter.service.ts:211
Pure: pounds → kilograms (formatted).
Parameters
Section titled “Parameters”| 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. |
Returns
Section titled “Returns”string
The formatted kilogram string.
Example
Section titled “Example”import { useToKilos } from "katanakit-js";
useToKilos(1); // "0.45"Implementation of
Section titled “Implementation of”useToMiles()
Section titled “useToMiles()”useToMiles( km, locale?, digits?): string;Defined in: core/services/converter.service.ts:154
Pure: kilometers → miles (formatted). Round-trips with UnitConverterService.useToKilometers.
Parameters
Section titled “Parameters”| 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. |
Returns
Section titled “Returns”string
The formatted mile string.
Example
Section titled “Example”import { useToMiles } from "katanakit-js";
useToMiles(1.60934); // "1.00"Implementation of
Section titled “Implementation of”useToPounds()
Section titled “useToPounds()”useToPounds( kilos, locale?, digits?): string;Defined in: core/services/converter.service.ts:230
Pure: kilograms → pounds (formatted).
Parameters
Section titled “Parameters”| 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. |
Returns
Section titled “Returns”string
The formatted pound string.
Example
Section titled “Example”import { useToPounds } from "katanakit-js";
useToPounds(1); // "2.20"Implementation of
Section titled “Implementation of”create()
Section titled “create()”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.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
formatter? |
IFormatterService |
Formatter to inject. Defaults to FormatterService. |
Returns
Section titled “Returns”UnitConverterService
A new UnitConverterService.
Example
Section titled “Example”const converter = UnitConverterService.create(myFormatter);getInstance()
Section titled “getInstance()”static getInstance(): UnitConverterService;Defined in: core/services/converter.service.ts:43
Returns the shared instance (Singleton).
Returns
Section titled “Returns”UnitConverterService