@fr0st/datetime 5.1.6 → 6.0.1

package/src/prototype/manipulate.js

@@ -1,4 +1,3 @@
-import { modify } from './../helpers.js';
 import { daysInMonth } from './../static/utility.js';
 
 /**
@@ -6,91 +5,391 @@ import { daysInMonth } from './../static/utility.js';
  */
 
 /**
- * Add a duration to the date.
- * @param {number} amount The amount to modify the date by.
- * @param {string} timeUnit The unit of time.
+ * Add a day to the current DateTime.
  * @return {DateTime} The DateTime object.
  */
-export function add(amount, timeUnit) {
-    return modify(this, amount, timeUnit);
+export function addDay() {
+    return this.addDays(1);
 };
 
 /**
- * Modify the DateTime by setting it to the end of a unit of time.
- * @param {string} timeUnit The unit of time.
+ * Add days to the current DateTime.
+ * @param {number} amount The number of days to add.
  * @return {DateTime} The DateTime object.
  */
-export function endOf(timeUnit) {
-    timeUnit = timeUnit.toLowerCase();
+export function addDays(amount) {
+    return this.setDate(
+        this.getDate() + amount,
+    );
+};
+
+/**
+ * Add an hour to the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function addHour() {
+    return this.addHours(1);
+};
+
+/**
+ * Add hours to the current DateTime.
+ * @param {number} amount The number of hours to add.
+ * @return {DateTime} The DateTime object.
+ */
+export function addHours(amount) {
+    return this.setTime(
+        this.getTime() + (amount * 3600000),
+    );
+};
+
+/**
+ * Add a minute to the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function addMinute() {
+    return this.addMinutes(1);
+};
+
+/**
+ * Add minutes to the current DateTime.
+ * @param {number} amount The number of minutes to add.
+ * @return {DateTime} The DateTime object.
+ */
+export function addMinutes(amount) {
+    return this.setTime(
+        this.getTime() + (amount * 60000),
+    );
+};
+
+/**
+ * Add a month to the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function addMonth() {
+    return this.addMonths(1);
+};
+
+/**
+ * Add months to the current DateTime.
+ * @param {number} amount The number of months to add.
+ * @return {DateTime} The DateTime object.
+ */
+export function addMonths(amount) {
+    return this.setMonth(
+        this.getMonth() + amount,
+    );
+};
+
+/**
+ * Add a second to the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function addSecond() {
+    return this.addSeconds(1);
+};
+
+/**
+ * Add seconds to the current DateTime.
+ * @param {number} amount The number of seconds to add.
+ * @return {DateTime} The DateTime object.
+ */
+export function addSeconds(amount) {
+    return this.setTime(
+        this.getTime() + (amount * 1000),
+    );
+};
+
+/**
+ * Add a week to the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function addWeek() {
+    return this.addWeeks(1);
+};
+
+/**
+ * Add weeks to the current DateTime.
+ * @param {number} amount The number of weeks to add.
+ * @return {DateTime} The DateTime object.
+ */
+export function addWeeks(amount) {
+    return this.setDate(
+        this.getDate() + (amount * 7),
+    );
+};
+
+/**
+ * Add a year to the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function addYear() {
+    return this.addYears(1);
+};
+
+/**
+ * Add years to the current DateTime.
+ * @param {number} amount The number of years to add.
+ * @return {DateTime} The DateTime object.
+ */
+export function addYears(amount) {
+    return this.setYear(
+        this.getYear() + amount,
+    );
+};
+
+/**
+ * Set the DateTime to the end of the day.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfDay() {
+    return this.setHours(23, 59, 59, 999);
+};
+
+/**
+ * Set the DateTime to the end of the hour.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfHour() {
+    return this.setMinutes(59, 59, 999);
+};
+
+/**
+ * Set the DateTime to the end of the minute.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfMinute() {
+    return this.setSeconds(59, 999);
+};
+
+/**
+ * Set the DateTime to the end of the month.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfMonth() {
+    return this.setDate(this.daysInMonth())
+        .endOfDay();
+}
+
+/**
+ * Set the DateTime to the end of the quarter.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfQuarter() {
+    const month = this.getQuarter() * 3;
+    return this.setMonth(month, daysInMonth(this.getYear(), month))
+        .endOfDay();
+};
+
+/**
+ * Set the DateTime to the end of the second.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfSecond() {
+    return this.setMilliseconds(999);
+};
+
+/**
+ * Set the DateTime to the end of the week.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfWeek() {
+    return this.setWeekDay(7)
+        .endOfDay();
+};
+
+/**
+ * Set the DateTime to the end of the year.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOfYear() {
+    return this.setMonth(12, 31)
+        .endOfDay();
+};
+
+/**
+ * Set the DateTime to the start of the day.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfDay() {
+    return this.setHours(0, 0, 0, 0);
+};
+
+/**
+ * Set the DateTime to the start of the hour.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfHour() {
+    return this.setMinutes(0, 0, 0);
+};
+
+/**
+ * Set the DateTime to the start of the minute.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfMinute() {
+    return this.setSeconds(0, 0);
+};
+
+/**
+ * Set the DateTime to the start of the month.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfMonth() {
+    return this.setDate(1)
+        .startOfDay();
+}
+
+/**
+ * Set the DateTime to the start of the quarter.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfQuarter() {
+    const month = this.getQuarter() * 3 - 2;
+    return this.setMonth(month, 1)
+        .startOfDay();
+};
+
+/**
+ * Set the DateTime to the start of the second.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfSecond() {
+    return this.setMilliseconds(0);
+};
+
+/**
+ * Set the DateTime to the start of the week.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfWeek() {
+    return this.setWeekDay(1)
+        .startOfDay();
+};
+
+/**
+ * Set the DateTime to the start of the year.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOfYear() {
+    return this.setMonth(1, 1)
+        .startOfDay();
+};
+
+/**
+ * Subtract a day from the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function subDay() {
+    return this.addDays(-1);
+};
+
+/**
+ * Subtract days from the current DateTime.
+ * @param {number} amount The number of days to subtract.
+ * @return {DateTime} The DateTime object.
+ */
+export function subDays(amount) {
+    return this.addDays(-amount);
+};
 
-    switch (timeUnit) {
-        case 'second':
-            return this.setMilliseconds(999);
-        case 'minute':
-            return this.setSeconds(59, 999);
-        case 'hour':
-            return this.setMinutes(59, 59, 999);
-        case 'day':
-            return this.setHours(23, 59, 59, 999);
-        case 'week':
-            return this.setWeekDay(7)
-                .setHours(23, 59, 59, 999);
-        case 'month':
-            return this.setDate(this.daysInMonth())
-                .setHours(23, 59, 59, 999);
-        case 'quarter':
-            const month = this.getQuarter() * 3;
-            return this.setMonth(month, daysInMonth(this.getYear(), month))
-                .setHours(23, 59, 59, 999);
-        case 'year':
-            return this.setMonth(12, 31)
-                .setHours(23, 59, 59, 999);
-        default:
-            throw new Error('Invalid time unit supplied');
-    }
+/**
+ * Subtract an hour from the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function subHour() {
+    return this.addHours(-1);
 };
 
 /**
- * Modify the DateTime by setting it to the start of a unit of time.
- * @param {string} timeUnit The unit of time.
+ * Subtract hours from the current DateTime.
+ * @param {number} amount The number of hours to subtract.
  * @return {DateTime} The DateTime object.
  */
-export function startOf(timeUnit) {
-    timeUnit = timeUnit.toLowerCase();
+export function subHours(amount) {
+    return this.addHours(-amount);
+};
 
-    switch (timeUnit) {
-        case 'second':
-            return this.setMilliseconds(0);
-        case 'minute':
-            return this.setSeconds(0, 0);
-        case 'hour':
-            return this.setMinutes(0, 0, 0);
-        case 'day':
-            return this.setHours(0, 0, 0, 0);
-        case 'week':
-            return this.setWeekDay(1)
-                .setHours(0, 0, 0, 0);
-        case 'month':
-            return this.setDate(1)
-                .setHours(0, 0, 0, 0);
-        case 'quarter':
-            const month = this.getQuarter() * 3 - 2;
-            return this.setMonth(month, 1)
-                .setHours(0, 0, 0, 0);
-        case 'year':
-            return this.setMonth(1, 1)
-                .setHours(0, 0, 0, 0);
-        default:
-            throw new Error('Invalid time unit supplied');
-    }
+/**
+ * Subtract a minute from the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function subMinute() {
+    return this.addMinutes(-1);
+};
+
+/**
+ * Subtract minutes from the current DateTime.
+ * @param {number} amount The number of minutes to subtract.
+ * @return {DateTime} The DateTime object.
+ */
+export function subMinutes(amount) {
+    return this.addMinutes(-amount);
+};
+
+/**
+ * Subtract a month from the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function subMonth() {
+    return this.addMonths(-1);
+};
+
+/**
+ * Subtract months from the current DateTime.
+ * @param {number} amount The number of months to subtract.
+ * @return {DateTime} The DateTime object.
+ */
+export function subMonths(amount) {
+    return this.addMonths(-amount);
+};
+
+/**
+ * Subtract a second from the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function subSecond() {
+    return this.addSeconds(-1);
+};
+
+/**
+ * Subtract seconds from the current DateTime.
+ * @param {number} amount The number of seconds to subtract.
+ * @return {DateTime} The DateTime object.
+ */
+export function subSeconds(amount) {
+    return this.addSeconds(-amount);
+};
+
+/**
+ * Subtract a week from the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function subWeek() {
+    return this.addWeeks(-1);
+};
+
+/**
+ * Subtract weeks from the current DateTime.
+ * @param {number} amount The number of weeks to subtract.
+ * @return {DateTime} The DateTime object.
+ */
+export function subWeeks(amount) {
+    return this.addWeeks(-amount);
+};
+
+/**
+ * Subtract a year from the current DateTime.
+ * @return {DateTime} The DateTime object.
+ */
+export function subYear() {
+    return this.addYears(-1);
 };
 
 /**
- * Subtract a duration from the date.
- * @param {number} amount The amount to modify the date by.
- * @param {string} timeUnit The unit of time.
+ * Subtract years from the current DateTime.
+ * @param {number} amount The number of years to subtract.
  * @return {DateTime} The DateTime object.
  */
-export function sub(amount, timeUnit) {
-    return modify(this, -amount, timeUnit);
+export function subYears(amount) {
+    return this.addYears(-amount);
 };

package/src/prototype/utility.js

@@ -1,6 +1,4 @@
 import DateTime from './../date-time.js';
-import { getRelativeFormatter } from './../factory.js';
-import { compensateDiff, getBiggestDiff } from './../helpers.js';
 import { formatDay, formatDayPeriod, formatEra, formatMonth, formatOffset, formatTimeZoneName } from './../formatter/format.js';
 import { minimumDays } from './../formatter/utility.js';
 import { daysInMonth as _daysInMonth, daysInYear as _daysInYear, isLeapYear as _isLeapYear } from './../static/utility.js';
@@ -54,136 +52,6 @@ export function daysInYear() {
     );
 };
 
-/**
- * Get the difference between this and another Date.
- * @param {DateTime} [other] The date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.timeUnit] The unit of time.
- * @param {Boolean} [options.relative=true] Whether to use the relative difference.
- * @return {number} The difference.
- */
-export function diff(other, { timeUnit, relative = true } = {}) {
-    if (!other) {
-        other = new this.constructor;
-    }
-
-    if (!timeUnit) {
-        return this - other;
-    }
-
-    if (timeUnit) {
-        timeUnit = timeUnit.toLowerCase();
-    }
-
-    other = other.setTimeZone(this.getTimeZone());
-
-    switch (timeUnit) {
-        case 'year':
-        case 'years':
-            const yearDiff = this.getYear() - other.getYear();
-            return compensateDiff(
-                this,
-                other.setYear(
-                    this.getYear(),
-                ),
-                yearDiff,
-                !relative,
-                -1,
-            );
-        case 'month':
-        case 'months':
-            const monthDiff = (this.getYear() - other.getYear()) *
-                12 +
-                this.getMonth() -
-                other.getMonth();
-            return compensateDiff(
-                this,
-                other.setYear(
-                    this.getYear(),
-                    this.getMonth(),
-                ),
-                monthDiff,
-                !relative,
-                -1,
-            );
-        case 'week':
-        case 'weeks':
-            const weekDiff = (this - other) / 604800000;
-            return compensateDiff(
-                this,
-                other.setWeekYear(
-                    this.getWeekYear(),
-                    this.getWeek(),
-                ),
-                weekDiff,
-                relative,
-            );
-        case 'day':
-        case 'days':
-            const dayDiff = (this - other) / 86400000;
-            return compensateDiff(
-                this,
-                other.setYear(
-                    this.getYear(),
-                    this.getMonth(),
-                    this.getDate(),
-                ),
-                dayDiff,
-                relative,
-            );
-        case 'hour':
-        case 'hours':
-            const hourDiff = (this - other) / 3600000;
-            return compensateDiff(
-                this,
-                other.setYear(
-                    this.getYear(),
-                    this.getMonth(),
-                    this.getDate(),
-                ).setHours(
-                    this.getHours(),
-                ),
-                hourDiff,
-                relative,
-            );
-        case 'minute':
-        case 'minutes':
-            const minuteDiff = (this - other) / 60000;
-            return compensateDiff(
-                this,
-                other.setYear(
-                    this.getYear(),
-                    this.getMonth(),
-                    this.getDate(),
-                ).setHours(
-                    this.getHours(),
-                    this.getMinutes(),
-                ),
-                minuteDiff,
-                relative,
-            );
-        case 'second':
-        case 'seconds':
-            const secondDiff = (this - other) / 1000;
-            return compensateDiff(
-                this,
-                other.setYear(
-                    this.getYear(),
-                    this.getMonth(),
-                    this.getDate(),
-                ).setHours(
-                    this.getHours(),
-                    this.getMinutes(),
-                    this.getSeconds(),
-                ),
-                secondDiff,
-                relative,
-            );
-        default:
-            throw new Error('Invalid time unit supplied');
-    }
-};
-
 /**
  * Get the era in current timeZone.
  * @param {string} [type=long] The type of era to return.
@@ -199,68 +67,6 @@ export function era(type = 'long') {
     );
 };
 
-/**
- * Get the difference between this and another Date in human readable form.
- * @param {DateTime} [other] The date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.timeUnit] The unit of time.
- * @return {string} The difference in human readable form.
- */
-export function humanDiff(other, { timeUnit } = {}) {
-    const relativeFormatter = getRelativeFormatter(this.getLocale());
-
-    if (!relativeFormatter) {
-        throw new Error('RelativeTimeFormat not supported');
-    }
-
-    if (!other) {
-        other = new this.constructor;
-    }
-
-    let amount;
-    if (timeUnit) {
-        amount = this.diff(other, { timeUnit });
-    } else {
-        [amount, timeUnit] = getBiggestDiff(this, other);
-    }
-
-    return relativeFormatter.format(amount, timeUnit);
-};
-
-/**
- * Determine whether this DateTime is after another date (optionally to a granularity).
- * @param {DateTime} [other] The date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.granularity] The level of granularity to use for comparison.
- * @return {Boolean} TRUE if this DateTime is after the other date, otherwise FALSE.
- */
-export function isAfter(other, { granularity } = {}) {
-    return this.diff(other, { timeUnit: granularity }) > 0;
-};
-
-/**
- * Determine whether this DateTime is before another date (optionally to a granularity).
- * @param {DateTime} [other] The date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.granularity] The level of granularity to use for comparison.
- * @return {Boolean} TRUE if this DateTime is before the other date, otherwise FALSE.
- */
-export function isBefore(other, { granularity } = {}) {
-    return this.diff(other, { timeUnit: granularity }) < 0;
-};
-
-/**
- * Determine whether this DateTime is between two other dates (optionally to a granularity).
- * @param {DateTime} [start] The first date to compare to.
- * @param {DateTime} [end] The second date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.granularity] The level of granularity to use for comparison.
- * @return {Boolean} TRUE if this DateTime is between the other dates, otherwise FALSE.
- */
-export function isBetween(start, end, { granularity } = {}) {
-    return this.diff(start, { timeUnit: granularity }) > 0 && this.diff(end, { timeUnit: granularity }) < 0;
-};
-
 /**
  * Return true if the DateTime is in daylight savings.
  * @return {Boolean} TRUE if the current time is in daylight savings, otherwise FALSE.
@@ -291,39 +97,6 @@ export function isLeapYear() {
     );
 };
 
-/**
- * Determine whether this DateTime is the same as another date (optionally to a granularity).
- * @param {DateTime} [other] The date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.granularity] The level of granularity to use for comparison.
- * @return {Boolean} TRUE if this DateTime is the same as the other date, otherwise FALSE.
- */
-export function isSame(other, { granularity } = {}) {
-    return this.diff(other, { timeUnit: granularity }) === 0;
-};
-
-/**
- * Determine whether this DateTime is the same or after another date (optionally to a granularity).
- * @param {DateTime} [other] The date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.granularity] The level of granularity to use for comparison.
- * @return {Boolean} TRUE if this DateTime is the same or after the other date, otherwise FALSE.
- */
-export function isSameOrAfter(other, { granularity } = {}) {
-    return this.diff(other, { timeUnit: granularity }) >= 0;
-};
-
-/**
- * Determine whether this DateTime is the same or before another date.
- * @param {DateTime} other The date to compare to.
- * @param {object} [options] The options for comparing the dates.
- * @param {string} [options.granularity] The level of granularity to use for comparison.
- * @return {Boolean} TRUE if this DateTime is the same or before the other date, otherwise FALSE.
- */
-export function isSameOrBefore(other, { granularity } = {}) {
-    return this.diff(other, { timeUnit: granularity }) <= 0;
-};
-
 /**
  * Get the name of the month in current timeZone.
  * @param {string} [type=long] The type of month name to return.