chore: update weight units to include milligram

Author: BlankRiser

README.md

@@ -10,7 +10,9 @@
 
 <p align="center">
 <a href="https://github.com/BlankRiser/unit-conversion/actions?query=branch%3Amain"><img src="https://github.com/BlankRiser/unit-conversion/actions/workflows/release.yml/badge.svg?event=push&branch=main" alt="Zod CI status" /></a>
-<a href="https://opensource.org/licenses/apache-2-0" rel="nofollow"><img src="https://img.shields.io/github/license/Blankriser/unit-conversion" alt="License"></a>
+<a href="https://opensource.org/licenses/apache-2-0" rel="nofollow"><img src="https://img.shields.io/github/license/Blankriser/unit-conversion" alt="license"></a>
+<a href="https://www.npmjs.com/package/@devhaven/unit-conversion" rel="nofollow"><img src="https://img.shields.io/npm/v/@devhaven/unit-conversion" alt="npm"></a>
+<a href="https://jsr.io/@devhaven/unit-conversion" rel="nofollow"><img src="https://img.shields.io/jsr/v/@devhaven/unit-conversion" alt="jsr"></a>
 </p>
 
 

src/constants/units.ts

@@ -9,7 +9,7 @@ export type LengthUnits =
 	| "foot"
 	| "yard"
 	| "mile";
-export type WeightUnits = "gram" | "kilogram" | "pound" | "ounce" | "ton";
+export type WeightUnits = "milligram" | "gram" | "kilogram" | "pound" | "ounce" | "ton";
 
 export type VolumeUnits =
 	| "liter"
@@ -34,12 +34,20 @@ export type TimeUnits =
 	| "month"
 	| "year";
 
+export type NumberUnits =
+	| "base10"
+	| "binary"
+	| "hexadecimal"
+	| "base2"
+	| "base8"
+
 export type AllUnits =
 	| TemperatureUnits
 	| LengthUnits
 	| WeightUnits
 	| VolumeUnits
-	| TimeUnits;
+	| TimeUnits
+	| NumberUnits
 
 export type UnitCategory<T extends AllUnits> = T extends TemperatureUnits
 	? TemperatureUnits
@@ -51,14 +59,17 @@ export type UnitCategory<T extends AllUnits> = T extends TemperatureUnits
 				? VolumeUnits
 				: T extends TimeUnits
 					? TimeUnits
-					: never;
+					: T extends NumberUnits
+						? NumberUnits
+						: never;
 
 export type ALL_UNITS = {
 	temperature: TemperatureUnits[];
 	length: LengthUnits[];
 	weight: WeightUnits[];
 	volume: VolumeUnits[];
 	time: TimeUnits[];
+	number: NumberUnits[];
 };
 
 /**
@@ -85,7 +96,7 @@ export const UNITS: ALL_UNITS = {
 		"yard",
 		"mile",
 	],
-	weight: ["gram", "kilogram", "pound", "ounce", "ton"],
+	weight: ["milligram","gram", "kilogram", "pound", "ounce", "ton"],
 	volume: [
 		"liter",
 		"milliliter",
@@ -109,4 +120,7 @@ export const UNITS: ALL_UNITS = {
 		"month",
 		"year",
 	],
+	number: ["base10", "binary", "hexadecimal", "base2", "base8"],
 };
+
+export const NO_UNITS_CATEGORIES = ["number"]

src/main.ts

@@ -1,6 +1,6 @@
 import { type ConversionConfig, DEFAULT_CONFIG } from "./constants/config";
 import { LABELS } from "./constants/labels";
-import type { AllUnits, UnitCategory } from "./constants/units";
+import { NO_UNITS_CATEGORIES, type AllUnits, type UnitCategory } from "./constants/units";
 import { getUnitCategory } from "./utils/common";
 import {
   CONVERSION_FACTORS,
@@ -45,7 +45,7 @@ class ValueWithFrom<T extends number> {
  */
 class FromUnit<T extends number, F extends AllUnits> {
   constructor(
-    private val: T,
+    private value: T,
     private fromUnit: F,
     private config: ConversionConfig
   ) {}
@@ -64,7 +64,7 @@ class FromUnit<T extends number, F extends AllUnits> {
     }
 
     // Convert from source unit to base unit, then to target unit
-    const baseValue = fromUnitFactors.toBase(this.val);
+    const baseValue = fromUnitFactors.toBase(this.value);
     const numericResult = toUnitFactors.fromBase(baseValue);
 
     const finalValue =
@@ -75,6 +75,9 @@ class FromUnit<T extends number, F extends AllUnits> {
     // Return with unit label if includeUnit is true (default)
     if (this.config.includeUnit !== false) {
       const unitLabel = LABELS[unit as keyof typeof LABELS] || unit;
+      if (NO_UNITS_CATEGORIES.includes(category.toString())) {
+        return finalValue;
+      }
       return `${finalValue}${unitLabel}`;
     }
 

src/utils/common.ts

@@ -26,6 +26,7 @@ export function getUnitCategory(unit: AllUnits): keyof typeof CONVERSION_FACTORS
 	if (isUnitInCategory(unit, "weight")) return "weight";
 	if (isUnitInCategory(unit, "volume")) return "volume";
 	if (isUnitInCategory(unit, "time")) return "time";
+	if (isUnitInCategory(unit, "number")) return "number";
 
 	throw new Error(`Unknown unit: ${unit}`);
 }
@@ -38,4 +39,4 @@ function isUnitInCategory<T extends keyof typeof UNITS>(
 	// We deliberately widen the array element type to AllUnits for the includes check,
 	// then use the type predicate to expose the precise narrowed type to callers.
 	return (UNITS[category] as ReadonlyArray<AllUnits>).includes(unit);
-}
+}

src/utils/conversion-factors.ts

@@ -4,22 +4,24 @@ export interface ConversionFactorGroups {
 	};
 }
 
+type ConversionFactorCallback = (v: number) => number;
+
 export interface ConversionFactor {
 	isBaseUnit?: boolean;
-	toBase: (v: number) => number;
-	fromBase: (v: number) => number;
+	toBase: ConversionFactorCallback;
+	fromBase: ConversionFactorCallback;
 }
 
 /**
  * Comprehensive conversion factors for various unit categories.
- * 
+ *
  * This object contains conversion factors organized by unit categories (temperature, length, weight, volume, time).
  * Each category defines a base unit and conversion functions to/from that base unit for all supported units
  * in that category.
- * 
+ *
  * @constant
  * @type {ConversionFactorGroups}
- * 
+ *
  * @property {Object} temperature - Temperature conversions with Kelvin as base unit
  * @property {Object} length - Length conversions with meter as base unit
  * @property {Object} weight - Weight conversions with gram as base unit
@@ -88,6 +90,11 @@ export const CONVERSION_FACTORS: ConversionFactorGroups = {
 			toBase: (v: number) => v,
 			fromBase: (v: number) => v,
 		},
+		milligram: {
+			isBaseUnit: true,
+			toBase: (v: number) => v / 1000,
+			fromBase: (v: number) => v * 1000,
+		},
 		kilogram: {
 			toBase: (v: number) => v * 1000,
 			fromBase: (v: number) => v / 1000,

tests/conversion.spec.ts

@@ -84,6 +84,7 @@ test("Test weight conversions", ()=>{
 	expect(convert.value(weightValue).from("gram").to("pound")).toBe("0.0022lb");
 	expect(convert.value(weightValue).from("gram").to("ounce")).toBe("0.0353oz");
 	expect(convert.value(weightValue).from("gram").to("ton")).toBe("0ton");
+	expect(convert.value(weightValue).from("gram").to("milligram")).toBe("1000mg");
 
 	expect(convert.value(weightValue).from("kilogram").to("gram")).toBe("1000g");
 	expect(convert.value(weightValue).from("kilogram").to("pound")).toBe("2.2046lb");