Temperature (ES)

⚖️ MIT

An ES (JavaScript & TypeScript) module to convert between units of the temperature.

Units of the temperature are from "Wikipedia - Conversion of scales of temperature".

	Names	Symbols
[SI] Kelvin	Kelvin	K
Celsius	Celsius	°C / C
Delisle	Delisle	°De / De / D
Fahrenheit	Fahrenheit	°F / F
Sir Isaac Newton's degree of temperature (Newton)	Newton	°N / N
Rankine	Rankine	°R / R / Ra
Réaumur	Réaumur / Reaumur	°Ré / Re / r
Rømer	Rømer / Roemer / Romer	°Rø / Ro

ℹ️ Note

This module uses the built in JavaScript Number type, which is a floating point number with a limited precision of 64 bits, about 16 digits. Floating point numbers round-off errors can occur during calculations:

0.1 + 0.2;
//=> 0.30000000000000004

In most cases, round-off errors do not matter, they have no significant impact on the results. However, it looks ugly when displaying output to a user. A solution is to limit the precision just below the actual precision of 16 digits in the displayed output:

(0.1 + 0.2).toPrecision(14);
//=> 0.3

🔰 Begin

🎯 Targets

	Registry - JSR	Registry - NPM	Remote Import
Bun >= v1.1.0	✔️ node_modules	✔️ Specifier npm:	❌
Cloudflare Workers	✔️ node_modules	✔️ node_modules	❌
Deno >= v1.42.0	✔️ Specifier jsr:	✔️ Specifier npm:	✔️
NodeJS >= v16.13.0	✔️ node_modules	✔️ node_modules	❌

ℹ️ Note

It is possible to use this module in other methods/ways which not listed in here, however it is not officially supported.

#️⃣ Registries Identifier

• JSR:

  @hugoalh/temperature
  

• NPM:

  @hugoalh/temperature
  

ℹ️ Note

• Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.
• It is recommended to use this module with tag for immutability.

#️⃣ Remote Import Paths

• GitHub Raw: (Require Tag)

  https://raw.githubusercontent.com/hugoalh-studio/temperature-es/${Tag}/mod.ts
  

ℹ️ Note

• Although it is recommended to import the entire module with the main path mod.ts, it is also able to import part of the module with sub path if available, but do not import if:

  • it's file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
  • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
  • it's symbol has an underscore prefix (e.g.: export function _baz() {}).

  These elements are not considered part of the public API, thus no stability is guaranteed for them.

• Although there have 3rd party services which provide enhanced, equal, or similar methods/ways to remote import the module, beware these services maybe inject unrelated elements and thus affect the security.

🛡️ Permissions

This module does not require any permission.

🧩 APIs

• class Temperature {
    constructor(fromValue: number, fromUnit: TemperatureUnitsInput = "K"): Temperature;
    toObject(): Record<TemperatureUnitsSymbolASCII, number>;
    toString(toUnit: TemperatureUnitsInput = "K"): string;
    toValue(toUnit: TemperatureUnitsInput = "K"): number;
    static unit(unit: TemperatureUnitsInput = "K"): TemperatureUnitMeta;
    static units(): TemperatureUnitMeta[];
  }

• function convertTemperature(fromValue: number, fromUnit: TemperatureUnitsInput = "K", toUnit: TemperatureUnitsInput = "K"): number;

• interface TemperatureUnitMeta {
    /**
     * Whether this is the SI unit of the temperature.
     */
    isSIUnit: boolean;
    /**
     * Names of the temperature unit, the standard name is at the first index.
     */
    names: string[];
    /**
     * ASCII symbol of the temperature unit, design for internal usage.
     */
    symbolASCII: string;
    /**
     * Symbols of the temperature unit, the standard symbol is at the first index.
     */
    symbols: string[];
  }

• type TemperatureUnitsInput = TemperatureUnitsNames | TemperatureUnitsSymbolASCII | TemperatureUnitsSymbols;

• type TemperatureUnitsNames = typeof unitsNames[TemperatureUnitsSymbolASCII][number];

• type TemperatureUnitsSymbolASCII = keyof typeof unitsSymbols;

• type TemperatureUnitsSymbols = typeof unitsSymbols[TemperatureUnitsSymbolASCII][number];

ℹ️ Note

For the prettier documentation, can visit via:

• Deno CLI deno doc
• JSR

✍️ Examples

• new Temperature(25, "C").toValue();
  //=> 298.15

• new Temperature(25, "C").toString();
  //=> "298.15 K"

• new Temperature(298.15).toValue("C");
  //=> 25

• new Temperature(298.15).toString("C");
  //=> "25 °C"