@hugoalh/temperature v2.0.2

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".

ℹ️ 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

🎯 Target

• Bun ^ v1.0.0
• Cloudflare Workers
• Deno >= v1.34.0 / >= v1.41.1 (For JSR Only)

  🛡️ Require Permission

  N/A

• NodeJS >= v16.13.0

🔰 Usage

Via JSR With node_modules

🎯 Supported Target

• Bun
• Cloudflare Workers
• NodeJS

1. Install via:
   • Bun

     bunx jsr add @hugoalh/temperature[@${Tag}]

   • NPM

     npx jsr add @hugoalh/temperature[@${Tag}]

   • PNPM

     pnpm dlx jsr add @hugoalh/temperature[@${Tag}]

   • Yarn

     yarn dlx jsr add @hugoalh/temperature[@${Tag}]

2. Import at the script:

   import ... from "@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 import the module with tag for immutability.

Via JSR With Specifier

🎯 Supported Target

• Deno

1. Import at the script:

   import ... from "jsr:@hugoalh/temperature[@${Tag}]";

ℹ️ 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 import the module with tag for immutability.

Via NPM With node_modules

🎯 Supported Target

• Cloudflare Workers
• NodeJS

1. Install via:
   • NPM

     npm install @hugoalh/temperature[@${Tag}]

   • PNPM

     pnpm add @hugoalh/temperature[@${Tag}]

   • Yarn

     yarn add @hugoalh/temperature[@${Tag}]

2. Import at the script:

   import ... from "@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 import the module with tag for immutability.

Via NPM With Specifier

🎯 Supported Target

• Bun
• Deno

1. Import at the script:

   import ... from "npm:@hugoalh/temperature[@${Tag}]";

ℹ️ 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 import the module with tag for immutability.

Via Remote Import

🎯 Supported Target

• Deno

1. Import at the script:

   /* Via GitHub Raw (Require Tag) */
   import ... from "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.

🧩 API

• 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

✍️ Example

• 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"