nhb-toolbox 3.4.0 → 3.4.2

package/dist/date/Chronos.d.ts

@@ -1,16 +1,26 @@
 export declare class Chronos {
-    private readonly _date;
+    private readonly date;
     /**
      * * Creates a new immutable Chronos instance.
-     * @param value - A date value (`timestamp`, `string`, or `Date`).
+     * @param value - A date value (`timestamp`, `string`, `Date`, `Chronos`).
      */
-    constructor(value?: number | string | Date);
+    constructor(value?: number | string | Date | Chronos);
+    /** * Gets the native `Date` instance (read-only). */
+    toDate(): Date;
+    /** * Returns a string representation of a date. The format of the string depends on the locale. */
+    toString(): string;
+    /** * Returns a date as a string value in ISO format. */
+    toISOString(): string;
+    /** * Returns the time value in milliseconds since midnight, January 1, 1970 UTC. */
+    getTimeStamp(): number;
+    /** * Returns the number of milliseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC). */
+    static now(): number;
     /**
      * * 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,7 +33,22 @@ export declare class Chronos {
      * @returns A new `Chronos` instance with the updated date.
      */
     subtractDays(days: number): Chronos;
-    /** * Gets the native `Date` instance (read-only). */
-    toDate(): Date;
+    /**
+     * * 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;
+    /**
+     * * Checks if the year is a leap year.
+     * - A year is a leap year if it is divisible by 4, but not divisible by 100, unless it is also divisible by 400.
+     * - For example, 2000 and 2400 are leap years, but 1900 and 2100 are not.
+     * @returns `true` if the year is a leap year, `false` otherwise.
+     */
+    isLeapYear(): boolean;
 }
 //# 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":"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,IAAI,CAAO;IAE5B;;;OAGG;gBACS,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAcpD,qDAAqD;IACrD,MAAM,IAAI,IAAI;IAId,mGAAmG;IACnG,QAAQ,IAAI,MAAM;IAIlB,wDAAwD;IACxD,WAAW,IAAI,MAAM;IAIrB,oFAAoF;IACpF,YAAY,IAAI,MAAM;IAItB,qHAAqH;IACrH,MAAM,CAAC,GAAG,IAAI,MAAM;IAIpB;;;;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;;;;;OAKG;IACH,UAAU,IAAI,OAAO;CAKrB"}

package/dist/date/Chronos.js

@@ -1,32 +1,54 @@
 import { DAYS, MONTHS, sortedFormats } from './constants';
 export class Chronos {
-    _date;
+    date;
     /**
      * * Creates a new immutable Chronos instance.
-     * @param value - A date value (`timestamp`, `string`, or `Date`).
+     * @param value - A date value (`timestamp`, `string`, `Date`, `Chronos`).
      */
     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!');
         }
-        this._date = date;
+        this.date = date;
+    }
+    /** * Gets the native `Date` instance (read-only). */
+    toDate() {
+        return new Date(this.date);
+    }
+    /** * Returns a string representation of a date. The format of the string depends on the locale. */
+    toString() {
+        return this.date.toString();
+    }
+    /** * Returns a date as a string value in ISO format. */
+    toISOString() {
+        return this.date.toISOString();
+    }
+    /** * Returns the time value in milliseconds since midnight, January 1, 1970 UTC. */
+    getTimeStamp() {
+        return this.date.getTime();
+    }
+    /** * Returns the number of milliseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC). */
+    static now() {
+        return Date.now();
     }
     /**
      * * 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) {
-        const year = this._date.getFullYear();
-        const month = this._date.getMonth();
-        const day = this._date.getDay();
-        const date = this._date.getDate();
-        const hours = this._date.getHours();
-        const minutes = this._date.getMinutes();
-        const seconds = this._date.getSeconds();
-        const milliseconds = this._date.getMilliseconds();
+    format(format = 'DD-MM-YYYY') {
+        const year = this.date.getFullYear();
+        const month = this.date.getMonth();
+        const day = this.date.getDay();
+        const date = this.date.getDate();
+        const hours = this.date.getHours();
+        const minutes = this.date.getMinutes();
+        const seconds = this.date.getSeconds();
+        const milliseconds = this.date.getMilliseconds();
         const dateComponents = {
             YYYY: String(year),
             YY: String(year).slice(-2),
@@ -89,7 +111,7 @@ export class Chronos {
      * @returns A new `Chronos` instance with the updated date.
      */
     addDays(days) {
-        const newDate = new Date(this._date);
+        const newDate = new Date(this.date);
         newDate.setDate(newDate.getDate() + days);
         return new Chronos(newDate);
     }
@@ -101,8 +123,34 @@ export class Chronos {
     subtractDays(days) {
         return this.addDays(-days);
     }
-    /** * Gets the native `Date` instance (read-only). */
-    toDate() {
-        return new Date(this._date);
+    /**
+     * * 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;
+    }
+    /**
+     * * Checks if the year is a leap year.
+     * - A year is a leap year if it is divisible by 4, but not divisible by 100, unless it is also divisible by 400.
+     * - For example, 2000 and 2400 are leap years, but 1900 and 2100 are not.
+     * @returns `true` if the year is a leap year, `false` otherwise.
+     */
+    isLeapYear() {
+        const year = this.date.getFullYear();
+        return (year % 4 === 0 && year % 100 !== 0) || year % 400 === 0;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "3.4.0",
+  "version": "3.4.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",