nhb-toolbox 4.31.0 → 4.31.2

package/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 All notable changes to the package will be documented here.
 
+## [4.31.2] - 2026-06-28
+
+- **Updated** tsdoc for `relativeTimePlugin` `Chronos` instance methods.
+
+## [4.31.1] - 2026-06-28
+
+- **Fixed** immutability issue with conversion to `Date` object for all the *date utilities* including `Chronos` constructor and plugins.
+
 ## [4.31.0] - 2026-06-16
 
 - **Added** new *methods* for `Color` class: `toString()`, `toJSON()`, `Symbol.toPrimitive`.

package/dist/cjs/date/Chronos.js

@@ -105,7 +105,7 @@ class Chronos {
     #toNewDate(value) {
         const date = value instanceof _a ? value.toDate() : (0, helpers_1._dateArgsToDate)(value);
         if (Number.isNaN(date.getTime())) {
-            throw new Error('Provided date is invalid!');
+            throw new TypeError('Provided date is invalid!');
         }
         return date;
     }

package/dist/cjs/date/helpers.js

@@ -156,9 +156,11 @@ function _padShunno(str, length = 2) {
     return str.padStart(length, '০');
 }
 function _dateArgsToDate(value) {
-    return (0, non_primitives_1.isDate)(value)
+    return new Date((0, non_primitives_1.isDate)(value)
         ? value
-        : new Date((0, primitives_1.isString)(value) ? value.replace(/['"]/g, '') : (value ?? Date.now()));
+        : (0, primitives_1.isString)(value)
+            ? value.replace(/['"]/g, '')
+            : (value ?? Date.now()));
 }
 function _hasChronosProperties(value) {
     return ((0, non_primitives_1.isObjectWithKeys)(value, [

package/dist/dts/date/plugins/relativeTimePlugin.d.ts

@@ -2,60 +2,55 @@ import type { $Chronos, ChronosInput, TimeUnit } from '../types';
 declare module '../Chronos' {
     interface Chronos {
         /**
-         * @instance Returns the number of full years between the input date and now.
+         * @instance Returns the number of full years between the input date and the current instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns The difference in number, negative when `Chronos` time is a past time else positive.
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeYear(time?: ChronosInput): number;
         /**
-         * @instance Returns the number of full months between the input date and now.
+         * @instance Returns the number of full months between the input date and the current instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns The difference in number, negative when `Chronos` time is a past time else positive.
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeMonth(time?: ChronosInput): number;
         /**
-         * @instance Determines if the given date is today, tomorrow, yesterday or any relative day.
-         * @param date - The date to compare (Date object).
+         * @instance Determines how many full weeks apart the input date is from the `Chronos` instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns
-         *  - `-1` if the date is yesterday.
-         *  - `0` if the date is today.
-         *  - `1` if the date is tomorrow.
-         *  - Other positive or negative numbers for other relative days (e.g., `-2` for two days ago, `2` for two days ahead).
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeWeek(time?: ChronosInput): number;
         /**
-         * @instance Returns the number of full hours between the input date and now.
+         * @instance Returns the number of full days between the input date and the current instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns The difference in number, negative when `Chronos` time is a past time else positive.
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeDay(time?: ChronosInput): number;
         /**
-         * @instance Determines how many full weeks apart the input date is from the `Chronos` instance.
+         * @instance Determines how many full hours apart the input date is from the `Chronos` instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns Difference in weeks; negative if past, positive if future.
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeHour(time?: ChronosInput): number;
         /**
-         * @instance Returns the number of full minutes between the input date and now.
+         * @instance Returns the number of full minutes between the input date and the current instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns The difference in number, negative when `Chronos` time is a past time else positive.
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeMinute(time?: ChronosInput): number;
         /**
-         * @instance Returns the number of full seconds between the input date and now.
+         * @instance Returns the number of full seconds between the input date and the current instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns The difference in number, negative when `Chronos` time is a past time else positive.
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeSecond(time?: ChronosInput): number;
         /**
-         * @instance Returns the number of milliseconds between the input date and now.
+         * @instance Returns the number of milliseconds between the input date and the current instance.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns The difference in number, negative when `Chronos` time is a past time else positive.
+         * @returns The difference in number, negative if past, positive if future.
          */
         getRelativeMilliSecond(time?: ChronosInput): number;
         /**
-         * @instance Compares the stored date with now, returning the relative difference in the specified unit.
+         * @instance Compares the stored date with the current instance, returning the relative difference in the specified unit.
          *
          * @remarks
          * - Internally uses {@link getRelativeYear}, {@link getRelativeMonth}, {@link getRelativeWeek}, {@link getRelativeDay}, {@link getRelativeHour}, {@link getRelativeMinute}, {@link getRelativeSecond} and {@link getRelativeMilliSecond} and rounds the result.
@@ -63,7 +58,7 @@ declare module '../Chronos' {
          *
          * @param unit The time unit to compare by. Defaults to `'minute'`.
          * @param time Optional time to compare with the `Chronos` date/time. Defaults to current time.
-         * @returns The difference in number, negative when `Chronos` time is a past time else positive.
+         * @returns The difference in number, negative if past, positive if future.
          */
         compare(unit?: TimeUnit, time?: ChronosInput): number;
         /** @instance Checks if the current date is today. */

package/dist/esm/date/Chronos.js

@@ -102,7 +102,7 @@ export class Chronos {
     #toNewDate(value) {
         const date = value instanceof _a ? value.toDate() : _dateArgsToDate(value);
         if (Number.isNaN(date.getTime())) {
-            throw new Error('Provided date is invalid!');
+            throw new TypeError('Provided date is invalid!');
         }
         return date;
     }

package/dist/esm/date/helpers.js

@@ -134,9 +134,11 @@ export function _padShunno(str, length = 2) {
     return str.padStart(length, '০');
 }
 export function _dateArgsToDate(value) {
-    return isDate(value)
+    return new Date(isDate(value)
         ? value
-        : new Date(isString(value) ? value.replace(/['"]/g, '') : (value ?? Date.now()));
+        : isString(value)
+            ? value.replace(/['"]/g, '')
+            : (value ?? Date.now()));
 }
 export function _hasChronosProperties(value) {
     return (isObjectWithKeys(value, [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "4.31.0",
+  "version": "4.31.2",
   "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",
@@ -44,12 +44,12 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@biomejs/biome": "^2.5.0",
+    "@biomejs/biome": "^2.5.1",
     "@types/jest": "^30.0.0",
-    "@types/node": "^25.9.3",
+    "@types/node": "^26.0.1",
     "husky": "^9.1.7",
     "jest": "^30.4.2",
-    "lint-staged": "^17.0.7",
+    "lint-staged": "^17.0.8",
     "nhb-scripts": "^1.9.2",
     "ts-jest": "^29.4.11",
     "typescript": "^6.0.3"