nhb-toolbox 3.6.0 → 3.6.2

package/dist/date/Chronos.d.ts

@@ -107,32 +107,60 @@ export declare class Chronos {
      * @returns The difference as string, e.g., `2 years 1 month 9 days 18 hours 56 minutes 9 seconds ago`.
      */
     fromNow(time?: string | number | Date | Chronos): string;
-    /** * Returns the number of full years between the input date and now. */
-    getRelativeYear(): number;
-    /** * Returns the number of full months between the input date and now. */
-    getRelativeMonth(): number;
+    /**
+     * * Returns the number of full years between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeYear(time?: string | number | Date | Chronos): number;
+    /**
+     * * Returns the number of full months between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeMonth(time?: string | number | Date | Chronos): number;
     /**
      * * Determines if the given date is today, tomorrow, yesterday or any relative day.
      * @param date - The date to compare (Date object).
+     * @param time Optional time to compare with the `Chronos` date/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).
      */
-    getRelativeDay(): number;
-    /** * Returns the number of full hours between the input date and now. */
-    getRelativeHour(): number;
-    /** * Returns the number of full minutes between the input date and now. */
-    getRelativeMinute(): number;
-    /** * Returns the number of full seconds between the input date and now. */
-    getRelativeSecond(): number;
-    /** * Returns the number of milliseconds between the input date and now. */
-    getRelativeMilliSecond(): number;
+    getRelativeDay(time?: string | number | Date | Chronos): number;
+    /**
+     * * Returns the number of full hours between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeHour(time?: string | number | Date | Chronos): number;
+    /**
+     * * Returns the number of full minutes between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeMinute(time?: string | number | Date | Chronos): number;
+    /**
+     *  * Returns the number of full seconds between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeSecond(time?: string | number | Date | Chronos): number;
+    /**
+     * * Returns the number of milliseconds between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeMilliSecond(time?: string | number | Date | Chronos): number;
     /**
      * * Compares the stored date with now, returning the difference in the specified unit.
+     *
      * @param unit The time unit to compare by. Defaults to 'minute'.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
      */
-    compare(unit?: TimeUnit): number;
+    compare(unit?: TimeUnit, time?: string | number | Date | Chronos): number;
 }
 //# sourceMappingURL=Chronos.d.ts.map

package/dist/date/Chronos.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Chronos.d.ts","sourceRoot":"","sources":["../../src/date/Chronos.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEX,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,MAAM,SAAS,CAAC;AAGjB,qBAAa,OAAO;;IAInB;;;;;;;;OAQG;gBACS,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAepD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED;;;;OAIG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAKnD,4EAA4E;IAC5E,MAAM,IAAI,MAAM;IAIhB,6EAA6E;IAC7E,OAAO,IAAI,MAAM;IAIjB,qDAAqD;IACrD,MAAM,IAAI,IAAI;IAId,mGAAmG;IACnG,QAAQ,IAAI,MAAM;IAIlB,wDAAwD;IACxD,WAAW,IAAI,MAAM;IAIrB,oFAAoF;IACpF,YAAY,IAAI,MAAM;IAItB,mDAAmD;IACnD,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,oFAAoF;IACpF,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM;IAOtC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM;IAO7C;;;;OAIG;IACH,MAAM,CAAC,GAAG,IAAI,MAAM;IA2FpB;;;;;;OAMG;IACH,MAAM,CACL,MAAM,GAAE,MAAwC,EAChD,MAAM,UAAQ,GACZ,MAAM;IAIT;;;;;OAKG;IACH,SAAS,CAAC,MAAM,GAAE,MAAwC,GAAG,MAAM;IAInE;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAM9B;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInC;;;;;OAKG;IACH,UAAU,IAAI,OAAO;IAMrB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO;IAiB7C,6CAA6C;IAC7C,OAAO,IAAI,OAAO;IAIlB,gDAAgD;IAChD,UAAU,IAAI,OAAO;IAIrB,iDAAiD;IACjD,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAgExD,yEAAyE;IACzE,eAAe,IAAI,MAAM;IAgBzB,0EAA0E;IAC1E,gBAAgB,IAAI,MAAM;IAc1B;;;;;;;;OAQG;IACH,cAAc,IAAI,MAAM;IAexB,yEAAyE;IACzE,eAAe,IAAI,MAAM;IAKzB,2EAA2E;IAC3E,iBAAiB,IAAI,MAAM;IAK3B,2EAA2E;IAC3E,iBAAiB,IAAI,MAAM;IAK3B,2EAA2E;IAC3E,sBAAsB,IAAI,MAAM;IAIhC;;;OAGG;IACH,OAAO,CAAC,IAAI,GAAE,QAAmB,GAAG,MAAM;CAoB1C"}
+{"version":3,"file":"Chronos.d.ts","sourceRoot":"","sources":["../../src/date/Chronos.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEX,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,MAAM,SAAS,CAAC;AAGjB,qBAAa,OAAO;;IAInB;;;;;;;;OAQG;gBACS,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAOpD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED;;;;OAIG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAKnD,4EAA4E;IAC5E,MAAM,IAAI,MAAM;IAIhB,6EAA6E;IAC7E,OAAO,IAAI,MAAM;IAIjB,qDAAqD;IACrD,MAAM,IAAI,IAAI;IAId,mGAAmG;IACnG,QAAQ,IAAI,MAAM;IAIlB,wDAAwD;IACxD,WAAW,IAAI,MAAM;IAIrB,oFAAoF;IACpF,YAAY,IAAI,MAAM;IAItB,mDAAmD;IACnD,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,oFAAoF;IACpF,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM;IAOtC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM;IAO7C;;;;OAIG;IACH,MAAM,CAAC,GAAG,IAAI,MAAM;IAyGpB;;;;;;OAMG;IACH,MAAM,CACL,MAAM,GAAE,MAAwC,EAChD,MAAM,UAAQ,GACZ,MAAM;IAIT;;;;;OAKG;IACH,SAAS,CAAC,MAAM,GAAE,MAAwC,GAAG,MAAM;IAInE;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAM9B;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInC;;;;;OAKG;IACH,UAAU,IAAI,OAAO;IAMrB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO;IAiB7C,6CAA6C;IAC7C,OAAO,IAAI,OAAO;IAIlB,gDAAgD;IAChD,UAAU,IAAI,OAAO;IAIrB,iDAAiD;IACjD,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAwDxD;;;;OAIG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAiBhE;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAgBjE;;;;;;;;;OASG;IACH,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAe/D;;;;OAIG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAKhE;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAKlE;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAKlE;;;;OAIG;IACH,sBAAsB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM;IAIvE;;;;;;OAMG;IACH,OAAO,CACN,IAAI,GAAE,QAAmB,EACzB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GACrC,MAAM;CAoBT"}

package/dist/date/Chronos.js

@@ -14,13 +14,7 @@ export class Chronos {
      * - If a Chronos object is provided, it will be converted to a Date object.
      */
     constructor(value) {
-        const date = value instanceof Chronos ?
-            value.toDate()
-            : new Date(value ?? Date.now());
-        // Check if the date is invalid
-        if (isNaN(date.getTime())) {
-            throw new Error('Provided date is invalid!');
-        }
+        const date = this.#toNewDate(value);
         this.#date = date;
         // this.preview = this.toISOString();
     }
@@ -99,6 +93,16 @@ export class Chronos {
     static now() {
         return Date.now();
     }
+    #toNewDate(value) {
+        const date = value instanceof Chronos ?
+            value.toDate()
+            : new Date(value ?? Date.now());
+        // Check if the date is invalid
+        if (isNaN(date.getTime())) {
+            throw new Error('Provided date is invalid!');
+        }
+        return date;
+    }
     /**
      * @private Formats the current `Chronos` date using the specified template.
      *
@@ -255,13 +259,7 @@ export class Chronos {
      * @returns The difference as string, e.g., `2 years 1 month 9 days 18 hours 56 minutes 9 seconds ago`.
      */
     fromNow(time) {
-        const now = time instanceof Chronos ?
-            time.toDate()
-            : new Date(time ?? Date.now());
-        // Check if the date is invalid
-        if (isNaN(now.getTime())) {
-            throw new Error('Provided date is invalid!');
-        }
+        const now = this.#toNewDate(time);
         const target = this.#date;
         const isFuture = target > now;
         const from = isFuture ? now : target;
@@ -309,23 +307,31 @@ export class Chronos {
             parts.push(`${seconds} second${seconds !== 1 ? 's' : ''}`);
         return `${isFuture ? 'in ' : ''}${parts.join(' ')}${isFuture ? '' : ' ago'}`;
     }
-    /** * Returns the number of full years between the input date and now. */
-    getRelativeYear() {
-        const now = new Date();
-        let years = now.getFullYear() - this.#date.getFullYear();
-        const hasNotHadBirthday = now.getMonth() < this.#date.getMonth() ||
+    /**
+     * * Returns the number of full years between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeYear(time) {
+        const now = this.#toNewDate(time);
+        let years = this.#date.getFullYear() - now.getFullYear();
+        const noYearMonthDay = now.getMonth() < this.#date.getMonth() ||
             (now.getMonth() === this.#date.getMonth() &&
                 now.getDate() < this.#date.getDate());
-        if (hasNotHadBirthday) {
+        if (noYearMonthDay) {
             years--;
         }
         return years;
     }
-    /** * Returns the number of full months between the input date and now. */
-    getRelativeMonth() {
-        const now = new Date();
-        let months = (now.getFullYear() - this.#date.getFullYear()) * 12 +
-            (now.getMonth() - this.#date.getMonth());
+    /**
+     * * Returns the number of full months between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeMonth(time) {
+        const now = this.#toNewDate(time);
+        let months = (this.#date.getFullYear() - now.getFullYear()) * 12 +
+            (this.#date.getMonth() - now.getMonth());
         const hasNotHadMonthDay = now.getDate() < this.#date.getDate();
         if (hasNotHadMonthDay) {
             months--;
@@ -335,62 +341,82 @@ export class Chronos {
     /**
      * * Determines if the given date is today, tomorrow, yesterday or any relative day.
      * @param date - The date to compare (Date object).
+     * @param time Optional time to compare with the `Chronos` date/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).
      */
-    getRelativeDay() {
-        const today = new Date();
+    getRelativeDay(time) {
+        const today = this.#toNewDate(time);
         // Set the time of today to 00:00:00 for comparison purposes
         today.setHours(0, 0, 0, 0);
         // Normalize the input date to 00:00:00
-        const inputDate = new Date(this.#date);
+        const inputDate = this.#date;
         inputDate.setHours(0, 0, 0, 0);
         const diffTime = inputDate.getTime() - today.getTime();
         const diffDays = Math.floor(diffTime / (1000 * 60 * 60 * 24));
         return diffDays;
     }
-    /** * Returns the number of full hours between the input date and now. */
-    getRelativeHour() {
-        const diff = new Date().getTime() - this.#date.getTime();
+    /**
+     * * Returns the number of full hours between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeHour(time) {
+        const diff = this.#date.getTime() - this.#toNewDate(time).getTime();
         return Math.floor(diff / (1000 * 60 * 60));
     }
-    /** * Returns the number of full minutes between the input date and now. */
-    getRelativeMinute() {
-        const diff = new Date().getTime() - this.#date.getTime();
+    /**
+     * * Returns the number of full minutes between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeMinute(time) {
+        const diff = this.#date.getTime() - this.#toNewDate(time).getTime();
         return Math.floor(diff / (1000 * 60));
     }
-    /** * Returns the number of full seconds between the input date and now. */
-    getRelativeSecond() {
-        const diff = new Date().getTime() - this.#date.getTime();
+    /**
+     *  * Returns the number of full seconds between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeSecond(time) {
+        const diff = this.#date.getTime() - this.#toNewDate(time).getTime();
         return Math.floor(diff / 1000);
     }
-    /** * Returns the number of milliseconds between the input date and now. */
-    getRelativeMilliSecond() {
-        return new Date().getTime() - this.#date.getTime();
+    /**
+     * * Returns the number of milliseconds between the input date and now.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
+     */
+    getRelativeMilliSecond(time) {
+        return this.#date.getTime() - this.#toNewDate(time).getTime();
     }
     /**
      * * Compares the stored date with now, returning the difference in the specified unit.
+     *
      * @param unit The time unit to compare by. Defaults to 'minute'.
+     * @param time Optional time to compare with the `Chronos` date/time.
+     * @returns The difference in number, negative is `Chronos` time is a past time else positive.
      */
-    compare(unit = 'minute') {
+    compare(unit = 'minute', time) {
         switch (unit) {
             case 'year':
-                return this.getRelativeYear();
+                return this.getRelativeYear(time);
             case 'month':
-                return this.getRelativeMonth();
+                return this.getRelativeMonth(time);
             case 'day':
-                return this.getRelativeDay();
+                return this.getRelativeDay(time);
             case 'hour':
-                return this.getRelativeHour();
+                return this.getRelativeHour(time);
             case 'minute':
-                return this.getRelativeMinute();
+                return this.getRelativeMinute(time);
             case 'second':
-                return this.getRelativeSecond();
+                return this.getRelativeSecond(time);
             case 'millisecond':
-                return this.getRelativeMilliSecond();
+                return this.getRelativeMilliSecond(time);
             default:
                 throw new Error(`Unsupported time unit: ${unit}`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "3.6.0",
+  "version": "3.6.2",
   "description": "A versatile collection of smart, efficient, and reusable utility functions for everyday development needs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",