nhb-toolbox 4.23.11 → 4.23.20

package/dist/dts/converter/area.d.ts

@@ -1,7 +1,7 @@
 import type { $Record } from '../object/types';
 import type { Numeric } from '../types/index';
 import { $BaseConverter } from './base';
-import type { $AreaUnit, ConverterFormatOptions } from './types';
+import type { $AreaUnit, FormatToOptions } from './types';
 /**
  * @class AreaConverter
  * @description Handles conversions with smart `.to()`, `.toAll()`, and `.formatTo()`.
@@ -30,5 +30,5 @@ export declare class $Area extends $BaseConverter<$AreaUnit> {
      * @param options Formatting options.
      * @returns Formatted string like "5km²", "5.02 square-miles", or "5e+3 meter".
      */
-    formatTo(target: $AreaUnit, options?: ConverterFormatOptions): string;
+    formatTo(target: $AreaUnit, options?: FormatToOptions): string;
 }

package/dist/dts/converter/base.d.ts

@@ -1,6 +1,6 @@
 import type { Numeric } from '../types/index';
 import type { Tuple } from '../utils/types';
-import type { $Unit, Category, CategoryUnits, ConverterFormatOptions } from './types';
+import type { $Unit, Category, CategoryUnits, FormatToOptions, Units } from './types';
 /**
  * @description Base class providing common mathematical and formatting utilities
  * for all unit converters (time, length, data, temperature, etc.).
@@ -26,7 +26,7 @@ export declare class $BaseConverter<Unit extends $Unit> {
      * @param options Formatting options.
      * @returns Formatted string according to style (compact, plural, scientific).
      */
-    protected $formatTo(value: number, target: Unit, shortLabels: Record<Unit, string>, options: ConverterFormatOptions | undefined): string;
+    protected $formatTo(value: number, target: Unit, shortLabels: Record<Unit, string>, options: FormatToOptions | undefined): string;
     /**
      * @instance Returns the numeric value.
      * @returns The raw numeric value without unit.
@@ -113,7 +113,7 @@ export declare class $BaseConverter<Unit extends $Unit> {
      * @instance Returns all supported units.
      * @returns Array of supported unit strings.
      */
-    supportedUnits(): Array<$Unit>;
+    supportedUnits(): Units;
     /**
      * @instance Returns all supported units for a specific category.
      * @param category Category to filter units by.

package/dist/dts/converter/data.d.ts

@@ -1,7 +1,7 @@
 import type { $Record } from '../object/types';
 import type { Numeric } from '../types/index';
 import { $BaseConverter } from './base';
-import type { $DataUnit, ConverterFormatOptions } from './types';
+import type { $DataUnit, FormatToOptions } from './types';
 /**
  * @class DataConverter
  * @description Handles conversions with smart `.to()`, `.toAll()`, and `.formatTo()`.
@@ -30,5 +30,5 @@ export declare class $Data extends $BaseConverter<$DataUnit> {
      * @param options Formatting options.
      * @returns Formatted string like "256MB", "256 megabytes", or "2.56e+2 MB".
      */
-    formatTo(target: $DataUnit, options?: ConverterFormatOptions): string;
+    formatTo(target: $DataUnit, options?: FormatToOptions): string;
 }

package/dist/dts/converter/length.d.ts

@@ -1,7 +1,7 @@
 import type { $Record } from '../object/types';
 import type { Numeric } from '../types/index';
 import { $BaseConverter } from './base';
-import type { $LengthUnit, ConverterFormatOptions } from './types';
+import type { $LengthUnit, FormatToOptions } from './types';
 /**
  * @class LengthConverter
  * @description Handles conversions with smart `.to()`, `.toAll()`, and `.formatTo()`.
@@ -30,5 +30,5 @@ export declare class $Length extends $BaseConverter<$LengthUnit> {
      * @param options Formatting options.
      * @returns Formatted string like "5km", "5.12 miles", or "5e+3 meter".
      */
-    formatTo(target: $LengthUnit, options?: ConverterFormatOptions): string;
+    formatTo(target: $LengthUnit, options?: FormatToOptions): string;
 }

package/dist/dts/converter/mass.d.ts

@@ -1,7 +1,7 @@
 import type { $Record } from '../object/types';
 import type { Numeric } from '../types/index';
 import { $BaseConverter } from './base';
-import type { $MassUnit, ConverterFormatOptions } from './types';
+import type { $MassUnit, FormatToOptions } from './types';
 /**
  * @class MassConverter
  * @description Handles conversions with smart `.to()`, `.toAll()`, and `.formatTo()`.
@@ -30,5 +30,5 @@ export declare class $Mass extends $BaseConverter<$MassUnit> {
      * @param options Formatting options.
      * @returns Formatted string like "5kg", "5.25 kilograms", or "5e+3 gram".
      */
-    formatTo(target: $MassUnit, options?: ConverterFormatOptions): string;
+    formatTo(target: $MassUnit, options?: FormatToOptions): string;
 }

package/dist/dts/converter/temp.d.ts

@@ -1,7 +1,7 @@
 import type { $Record } from '../object/types';
 import type { Numeric } from '../types/index';
 import { $BaseConverter } from './base';
-import type { $TempUnit, ConverterFormatOptions } from './types';
+import type { $TempUnit, FormatToOptions } from './types';
 /**
  * @class TemperatureConverter
  * @description Handles conversions with smart `.to()`, `.toAll()`, and `.formatTo()`.
@@ -30,5 +30,5 @@ export declare class $Temperature extends $BaseConverter<$TempUnit> {
      * @param options Formatting options.
      * @returns Formatted string like "95°F", "5.25 kelvins", or "5e+3 celsius".
      */
-    formatTo(target: $TempUnit, options?: ConverterFormatOptions): string;
+    formatTo(target: $TempUnit, options?: FormatToOptions): string;
 }

package/dist/dts/converter/time.d.ts

@@ -1,7 +1,7 @@
 import type { $Record } from '../object/types';
 import type { Numeric } from '../types/index';
 import { $BaseConverter } from './base';
-import type { $TimeUnit, ConverterFormatOptions } from './types';
+import type { $TimeUnit, FormatToOptions } from './types';
 /**
  * @class TimeConverter
  * @description Handles conversions with smart `.to()`, `.toAll()`, and `.formatTo()`.
@@ -30,5 +30,5 @@ export declare class $Time extends $BaseConverter<$TimeUnit> {
      * @param options Formatting options.
      * @returns Formatted string like "5h", "5.25 hours", or "5e+3 minute".
      */
-    formatTo(target: $TimeUnit, options?: ConverterFormatOptions): string;
+    formatTo(target: $TimeUnit, options?: FormatToOptions): string;
 }

package/dist/dts/converter/types.d.ts

@@ -9,25 +9,27 @@ import type { $Temperature } from './temp';
 import type { $Time } from './time';
 import type { $Volume } from './volume';
 /** - Type for Record of Units */
-type Units = typeof UNITS;
+type UnitsRecord = typeof UNITS;
 /** * Category of units supported by the converter. */
-export type Category = keyof Units;
+export type Category = keyof UnitsRecord;
 /** * Map of unit categories to their respective units. */
 export type UnitMap = {
-    [Key in Category]: Units[Key][number];
+    [Key in Category]: UnitsRecord[Key][number];
 };
 /** * Union type of all supported units. May include any other strings. */
 export type $Unit = LooseLiteral<UnitMap[Category]>;
+/** * Type for array of all Units */
+export type Units = Array<UnitMap[Category]>;
 /** * Infer the category of a given unit type `U`. */
 export type InferCategory<U extends $Unit> = {
     [K in Category]: U extends UnitMap[K] ? K : never;
 }[Category];
-/** Infer Units belong to a specific Category */
+/** * Infer Units belong to a specific Category */
 export type CategoryUnits<Cat extends Category> = UnitMap[Cat];
 /** * Type for the returned converter instance based on the provided unit `U`. */
 export type Converted<U extends $Unit> = InferCategory<U> extends never ? $BaseConverter<U> : InferCategory<U> extends 'area' ? $Area : InferCategory<U> extends 'time' ? $Time : InferCategory<U> extends 'length' ? $Length : InferCategory<U> extends 'mass' ? $Mass : InferCategory<U> extends 'data' ? $Data : InferCategory<U> extends 'temp' ? $Temperature : InferCategory<U> extends 'volume' ? $Volume : $BaseConverter<U>;
-/** * Options for formatting converted values. */
-export type ConverterFormatOptions = {
+/** * Options for formatting converted values for unit converter method(s). */
+export type FormatToOptions = {
     /** Style of formatting. Default is `'plural'`. */
     style?: 'compact' | 'scientific' | 'plural';
     /** Number of decimal places to include. Default is `2`. */

package/dist/dts/converter/volume.d.ts

@@ -1,7 +1,7 @@
 import type { $Record } from '../object/types';
 import type { Numeric } from '../types/index';
 import { $BaseConverter } from './base';
-import type { $VolumeUnit, ConverterFormatOptions } from './types';
+import type { $VolumeUnit, FormatToOptions } from './types';
 /**
  * @class VolumeConverter
  * @description Handles conversions with smart `.to()`, `.toAll()`, and `.formatTo()`.
@@ -30,5 +30,5 @@ export declare class $Volume extends $BaseConverter<$VolumeUnit> {
      * @param options Formatting options.
      * @returns Formatted string like "5m³", "5.25 cubic-meters", or "5e+3 meter".
      */
-    formatTo(target: $VolumeUnit, options?: ConverterFormatOptions): string;
+    formatTo(target: $VolumeUnit, options?: FormatToOptions): string;
 }

package/dist/dts/date/types.d.ts

@@ -197,7 +197,7 @@ export type UTCMinute = '00' | '15' | '30' | '45';
 export type $UTCOffset = `${PositiveUTCHour | NegativeUTCHour}:${UTCMinute}`;
 /** UTC offset in `UTC±HH:mm` format */
 export type UTCOffSet = `UTC${$UTCOffset}`;
-/** Chronos Date Format options */
+/** `Chronos` Date Format options */
 export interface FormatOptions {
     /** - The desired format (Default format is dd, `MMM DD, YYYY HH:mm:ss` = `Sun, Apr 06, 2025 16:11:55). */
     format?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "4.23.11",
+  "version": "4.23.20",
   "description": "A versatile collection of smart, efficient, and reusable utility functions, classes and types for everyday development needs.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -124,6 +124,11 @@
       "import": "./dist/esm/date/Chronos.js",
       "require": "./dist/cjs/date/Chronos.js"
     },
+    "./color": {
+      "types": "./dist/dts/colors/Color.d.ts",
+      "import": "./dist/esm/colors/Color.js",
+      "require": "./dist/cjs/colors/Color.js"
+    },
     "./converter": {
       "types": "./dist/dts/converter/Converter.d.ts",
       "import": "./dist/esm/converter/Converter.js",
@@ -259,6 +264,9 @@
       "chronos": [
         "dist/dts/date/Chronos.d.ts"
       ],
+      "color": [
+        "dist/dts/colors/Color.d.ts"
+      ],
       "converter": [
         "dist/dts/converter/Converter.d.ts"
       ],