nhb-toolbox 3.4.0 → 3.4.1

package/dist/date/Chronos.d.ts

@@ -4,13 +4,13 @@ export declare class Chronos {
      * * Creates a new immutable Chronos instance.
      * @param value - A date value (`timestamp`, `string`, or `Date`).
      */
-    constructor(value?: number | string | Date);
+    constructor(value?: number | string | Date | Chronos);
     /**
      * * Formats the date into a custom string format.
-     * @param format - The desired format (e.g., "YYYY-MM-DD").
-     * @returns Formatted date string.
+     * @param format - The desired format (Default format is `DD-MM-YYYY` = `30-06-1995`).
+     * @returns Formatted date string in desired format.
      */
-    format(format: string): string;
+    format(format?: string): string;
     /**
      * * Adds days and returns a new immutable instance.
      * @param days - Number of days to add.
@@ -23,6 +23,16 @@ export declare class Chronos {
      * @returns A new `Chronos` instance with the updated date.
      */
     subtractDays(days: number): Chronos;
+    /**
+     * * Determines if the given date is today, tomorrow, yesterday or any relative day.
+     * @param date - The date to compare (Date object).
+     * @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;
     /** * Gets the native `Date` instance (read-only). */
     toDate(): Date;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"Chronos.d.ts","sourceRoot":"","sources":["../../src/date/Chronos.ts"],"names":[],"mappings":"AAGA,qBAAa,OAAO;IACnB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;IAE7B;;;OAGG;gBACS,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAW1C;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IA2E9B;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAM9B;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInC,qDAAqD;IACrD,MAAM,IAAI,IAAI;CAwBd"}
+{"version":3,"file":"Chronos.d.ts","sourceRoot":"","sources":["../../src/date/Chronos.ts"],"names":[],"mappings":"AAGA,qBAAa,OAAO;IACnB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;IAE7B;;;OAGG;gBACS,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAcpD;;;;OAIG;IACH,MAAM,CAAC,MAAM,GAAE,MAAqB,GAAG,MAAM;IA2E7C;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAM9B;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInC;;;;;;;;OAQG;IACH,cAAc,IAAI,MAAM;IAexB,qDAAqD;IACrD,MAAM,IAAI,IAAI;CAGd"}

package/dist/date/Chronos.js

@@ -6,7 +6,9 @@ export class Chronos {
      * @param value - A date value (`timestamp`, `string`, or `Date`).
      */
     constructor(value) {
-        const date = new Date(value ?? Date.now());
+        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('Invalid date provided!');
@@ -15,10 +17,10 @@ export class Chronos {
     }
     /**
      * * Formats the date into a custom string format.
-     * @param format - The desired format (e.g., "YYYY-MM-DD").
-     * @returns Formatted date string.
+     * @param format - The desired format (Default format is `DD-MM-YYYY` = `30-06-1995`).
+     * @returns Formatted date string in desired format.
      */
-    format(format) {
+    format(format = 'DD-MM-YYYY') {
         const year = this._date.getFullYear();
         const month = this._date.getMonth();
         const day = this._date.getDay();
@@ -101,6 +103,26 @@ export class Chronos {
     subtractDays(days) {
         return this.addDays(-days);
     }
+    /**
+     * * Determines if the given date is today, tomorrow, yesterday or any relative day.
+     * @param date - The date to compare (Date object).
+     * @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();
+        // 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);
+        inputDate.setHours(0, 0, 0, 0);
+        const diffTime = inputDate.getTime() - today.getTime();
+        const diffDays = Math.floor(diffTime / (1000 * 60 * 60 * 24));
+        return diffDays;
+    }
     /** * Gets the native `Date` instance (read-only). */
     toDate() {
         return new Date(this._date);

package/package.json

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