chronos-ts 1.1.0 → 2.0.0

package/dist/interval.d.ts

@@ -1,61 +0,0 @@
-export declare class Interval {
-    private minutes;
-    private hours;
-    private days;
-    private weeks;
-    private months;
-    /**
-     * Constructs a new instance of the Interval class.
-     *
-     * @param minutes - The number of minutes (default is 0).
-     * @param hours - The number of hours (default is 0).
-     * @param days - The number of days (default is 0).
-     * @param weeks - The number of weeks (default is 0).
-     * @param months - The number of months (default is 0).
-     */
-    private constructor();
-    /**
-     * Creates an Interval instance representing the specified number of minutes.
-     *
-     * @param minutes - The number of minutes for the interval.
-     * @returns An Interval instance representing the specified number of minutes.
-     */
-    static minutes(minutes: number): Interval;
-    /**
-     * Creates an Interval instance representing the given number of hours.
-     *
-     * @param hours - The number of hours for the interval.
-     * @returns An Interval instance with the specified hours.
-     */
-    static hours(hours: number): Interval;
-    /**
-     * Creates an Interval instance representing the specified number of days.
-     *
-     * @param days - The number of days for the interval.
-     * @returns An Interval instance with the specified number of days.
-     */
-    static days(days: number): Interval;
-    /**
-     * Creates an Interval instance representing the specified number of weeks.
-     *
-     * @param weeks - The number of weeks for the interval.
-     * @returns An Interval instance with the specified number of weeks.
-     */
-    static weeks(weeks: number): Interval;
-    /**
-     * Creates an Interval instance representing a specified number of months.
-     *
-     * @param months - The number of months for the interval.
-     * @returns An Interval instance with the specified number of months.
-     */
-    static months(months: number): Interval;
-    /**
-     * Calculates the total interval in minutes.
-     *
-     * This method sums up the minutes, hours, days, weeks, and months
-     * to return the total interval in minutes.
-     *
-     * @returns {number} The total interval in minutes.
-     */
-    getMinutesInterval(): number;
-}

package/dist/interval.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Interval = void 0;
-class Interval {
-    /**
-     * Constructs a new instance of the Interval class.
-     *
-     * @param minutes - The number of minutes (default is 0).
-     * @param hours - The number of hours (default is 0).
-     * @param days - The number of days (default is 0).
-     * @param weeks - The number of weeks (default is 0).
-     * @param months - The number of months (default is 0).
-     */
-    constructor(minutes = 0, hours = 0, days = 0, weeks = 0, months = 0) {
-        this.minutes = minutes;
-        this.hours = hours;
-        this.days = days;
-        this.weeks = weeks;
-        this.months = months;
-    }
-    /**
-     * Creates an Interval instance representing the specified number of minutes.
-     *
-     * @param minutes - The number of minutes for the interval.
-     * @returns An Interval instance representing the specified number of minutes.
-     */
-    static minutes(minutes) {
-        return new Interval(minutes);
-    }
-    /**
-     * Creates an Interval instance representing the given number of hours.
-     *
-     * @param hours - The number of hours for the interval.
-     * @returns An Interval instance with the specified hours.
-     */
-    static hours(hours) {
-        return new Interval(0, hours);
-    }
-    /**
-     * Creates an Interval instance representing the specified number of days.
-     *
-     * @param days - The number of days for the interval.
-     * @returns An Interval instance with the specified number of days.
-     */
-    static days(days) {
-        return new Interval(0, 0, days);
-    }
-    /**
-     * Creates an Interval instance representing the specified number of weeks.
-     *
-     * @param weeks - The number of weeks for the interval.
-     * @returns An Interval instance with the specified number of weeks.
-     */
-    static weeks(weeks) {
-        return new Interval(0, 0, 0, weeks);
-    }
-    /**
-     * Creates an Interval instance representing a specified number of months.
-     *
-     * @param months - The number of months for the interval.
-     * @returns An Interval instance with the specified number of months.
-     */
-    static months(months) {
-        return new Interval(0, 0, 0, 0, months);
-    }
-    /**
-     * Calculates the total interval in minutes.
-     *
-     * This method sums up the minutes, hours, days, weeks, and months
-     * to return the total interval in minutes.
-     *
-     * @returns {number} The total interval in minutes.
-     */
-    getMinutesInterval() {
-        return (this.minutes +
-            this.hours * 60 +
-            this.days * 24 * 60 +
-            this.weeks * 7 * 24 * 60 +
-            this.months * 30 * 24 * 60);
-    }
-}
-exports.Interval = Interval;

package/dist/period.d.ts

@@ -1,196 +0,0 @@
-import { Interval } from './interval';
-import { Precision } from './precision';
-export declare class Period {
-    private startDate;
-    private endDate;
-    private precision;
-    private interval;
-    /**
-     * Constructs a new Period instance.
-     *
-     * @param start - The start date of the period, either as a string or a Date object.
-     * @param end - The end date of the period, either as a string or a Date object.
-     * @param precision - The precision level of the period, defaulting to Precision.DAY.
-     * @param interval - An optional interval associated with the period, defaulting to null.
-     * @throws {Error} If start date is after end date or if dates are invalid.
-     */
-    constructor(start: string | Date, end: string | Date, precision?: Precision, interval?: Interval | null);
-    /**
-     * Validates and converts a date input to a Date object.
-     *
-     * @param date - The date to validate, either as a string or Date object.
-     * @returns A valid Date object.
-     * @throws {Error} If the date is invalid.
-     */
-    private validateDate;
-    /**
-     * Retrieves the start date of the period.
-     *
-     * @returns {Date} The start date as a Date object.
-     */
-    getStartDate(): Date;
-    /**
-     * Retrieves the end date of the period.
-     *
-     * @returns {Date} The end date as a Date object.
-     */
-    getEndDate(): Date;
-    /**
-     * Checks if a given date is within the period defined by `startDate` and `endDate`.
-     *
-     * @param date - The date to check, either as a string or a Date object.
-     * @returns `true` if the date is within the period, `false` otherwise.
-     */
-    contains(date: string | Date): boolean;
-    /**
-     * Determines if the current period overlaps with another period.
-     *
-     * @param other - The other period to compare with.
-     * @returns `true` if the periods overlap, otherwise `false`.
-     */
-    overlapsWith(other: Period): boolean;
-    /**
-     * Determines if the current period is adjacent to another period.
-     *
-     * Two periods are considered adjacent if they do not overlap and the gap
-     * between them is within one precision unit of the larger precision of the two periods.
-     *
-     * @param other - The other period to compare with.
-     * @returns `true` if the periods are adjacent, `false` otherwise.
-     */
-    isAdjacentTo(other: Period): boolean;
-    /**
-     * Retrieves an array of dates within the specified interval.
-     *
-     * @returns {Date[] | null} An array of dates if the interval is defined, otherwise `null`.
-     */
-    getDatesInInterval(): Date[] | null;
-    /**
-     * Calculates the number of minutes in the interval between the start and end dates.
-     *
-     * @returns {number} The number of minutes between the start and end dates.
-     */
-    getMinutesInInterval(): number;
-    /**
-     * Calculates the number of whole hours in the interval.
-     *
-     * @returns {number} The number of whole hours in the interval.
-     */
-    getHoursInInterval(): number;
-    /**
-     * Calculates the number of whole days in the interval.
-     *
-     * @returns The number of whole days in the interval.
-     */
-    getDaysInInterval(): number;
-    /**
-     * Calculates the number of whole weeks in the interval.
-     *
-     * @returns The number of whole weeks in the interval.
-     */
-    getWeeksInInterval(): number;
-    /**
-     * Calculates the number of whole months in the interval between the start and end dates.
-     *
-     * This method computes the difference in months between the `startDate` and `endDate` properties.
-     * It adjusts for month boundaries by decrementing the month count if the end date's day is less than the start date's day.
-     *
-     * @returns {number} The number of whole months in the interval.
-     */
-    getMonthsInInterval(): number;
-    /**
-     * Calculates the number of whole years in the interval.
-     *
-     * @returns The number of whole years in the interval.
-     */
-    getYearsInInterval(): number;
-    /**
-     * Calculates the length of the period in the specified precision.
-     *
-     * @returns {number} The length of the period, rounded down to the nearest whole number.
-     */
-    length(): number;
-    /**
-     * Determines the overlapping period between this period and another period.
-     *
-     * @param other - The other period to check for overlap with.
-     * @returns The overlapping period as a new `Period` instance, or `null` if there is no overlap.
-     */
-    overlap(other: Period): Period | null;
-    /**
-     * Subtracts the given period from the current period and returns the resulting periods.
-     * If the periods do not overlap, the current period is returned as a single-element array.
-     * If they do overlap, the resulting periods are returned as an array.
-     *
-     * @param other - The period to subtract from the current period.
-     * @returns An array of resulting periods after subtraction.
-     */
-    subtract(other: Period): Period[];
-    /**
-     * Calculates the gap between this period and another period.
-     * If the periods overlap or are adjacent, returns null.
-     * Otherwise, returns a new Period representing the gap between the two periods.
-     *
-     * @param other - The other period to compare with.
-     * @returns A new Period representing the gap, or null if the periods overlap or are adjacent.
-     */
-    gap(other: Period): Period | null;
-    /**
-     * Computes the symmetric difference between this period and another period.
-     * The symmetric difference is defined as the set of periods that are in either
-     * of the two periods but not in their intersection.
-     *
-     * @param other - The other period to compute the symmetric difference with.
-     * @returns An array of periods representing the symmetric difference, sorted
-     *          by start date and merged if adjacent.
-     */
-    symmetricDifference(other: Period): Period[];
-    private mergeAdjacentPeriods;
-    /**
-     * Renews the current period by creating a new `Period` instance.
-     * The new period starts immediately after the end of the current period
-     * and has the same length and precision.
-     *
-     * @returns {Period} A new `Period` instance with updated start and end dates.
-     */
-    renew(): Period;
-    /**
-     * Computes the union of this period with another period.
-     * If the periods overlap or are adjacent, they are merged into a single period.
-     * Otherwise, the periods are returned as separate, sorted periods.
-     *
-     * @param other - The other period to union with this period.
-     * @returns An array of periods resulting from the union operation.
-     */
-    union(other: Period): Period[];
-    /**
-     * Sets the start date for the period.
-     *
-     * @param start - The start date, which can be a string or a Date object.
-     * @returns The current instance for method chaining.
-     * @throws {Error} If the new start date is after the current end date.
-     */
-    setStart(start: string | Date): this;
-    /**
-     * Sets the end date for the period.
-     *
-     * @param end - The end date as a string or Date object.
-     * @returns The current instance for method chaining.
-     * @throws {Error} If the new end date is before the current start date.
-     */
-    setEnd(end: string | Date): this;
-    /**
-     * Sets the precision for the period.
-     *
-     * @param precision - The precision to set.
-     * @returns The current instance for method chaining.
-     */
-    setPrecision(precision: Precision): this;
-    /**
-     * Sets the interval for the period.
-     *
-     * @param interval - The interval to be set.
-     * @returns The current instance of the period.
-     */
-    setInterval(interval: Interval): this;
-}