@fr0st/datetime 5.0.0

package/src/prototype/attributes-get.js

@@ -0,0 +1,163 @@
+import { getOffsetTime } from './../helpers.js';
+import { minimumDays, weekDay } from './../formatter/utility.js';
+import { dayOfYear } from './../static/utility.js';
+
+/**
+ * DateTime Attributes (Get)
+ */
+
+/**
+ * Get the date of the month in current timeZone.
+ * @return {number} The date of the month.
+ */
+export function getDate() {
+    return new Date(getOffsetTime(this)).getUTCDate();
+};
+
+/**
+ * Get the day of the week in current timeZone.
+ * @return {number} The day of the week. (0 - Sunday, 6 - Saturday)
+ */
+export function getDay() {
+    return new Date(getOffsetTime(this)).getUTCDay();
+};
+
+/**
+ * Get the day of the year in current timeZone.
+ * @return {number} The day of the year. (1, 366)
+ */
+export function getDayOfYear() {
+    return dayOfYear(
+        this.getYear(),
+        this.getMonth(),
+        this.getDate(),
+    );
+};
+
+/**
+ * Get the hours of the day in current timeZone.
+ * @return {number} The hours of the day. (0, 23)
+ */
+export function getHours() {
+    return new Date(getOffsetTime(this)).getUTCHours();
+};
+
+/**
+ * Get the milliseconds in current timeZone.
+ * @return {number} The milliseconds.
+ */
+export function getMilliseconds() {
+    return new Date(getOffsetTime(this)).getUTCMilliseconds();
+};
+
+/**
+ * Get the minutes in current timeZone.
+ * @return {number} The minutes. (0, 59)
+ */
+export function getMinutes() {
+    return new Date(getOffsetTime(this)).getUTCMinutes();
+};
+
+/**
+ * Get the month in current timeZone.
+ * @return {number} The month. (1, 12)
+ */
+export function getMonth() {
+    return new Date(getOffsetTime(this)).getUTCMonth() + 1;
+};
+
+/**
+ * Get the quarter of the year in current timeZone.
+ * @return {number} The quarter of the year. (1, 4)
+ */
+export function getQuarter() {
+    return Math.ceil(this.getMonth() / 3);
+};
+
+/**
+ * Get the seconds in current timeZone.
+ * @return {number} The seconds. (0, 59)
+ */
+export function getSeconds() {
+    return new Date(getOffsetTime(this)).getUTCSeconds();
+};
+
+/**
+ * Get the number of seconds since the UNIX epoch.
+ * @return {number} The number of seconds since the UNIX epoch.
+ */
+export function getTimestamp() {
+    return Math.floor(this.getTime() / 1000);
+};
+
+/**
+ * Get the local week in current timeZone.
+ * @return {number} The local week. (1, 53)
+ */
+export function getWeek() {
+    const thisWeek = this.startOf('day').setWeekDay(1);
+    const firstWeek = thisWeek.setWeek(1, 1);
+
+    return 1 +
+        (
+            (
+                (thisWeek - firstWeek) /
+                604800000
+            ) | 0
+        );
+};
+
+/**
+ * Get the local day of the week in current timeZone.
+ * @return {number} The local day of the week. (1 - 7)
+ */
+export function getWeekDay() {
+    return weekDay(
+        this.getLocale(),
+        this.getDay(),
+    );
+};
+
+/**
+ * Get the week day in month in current timeZone.
+ * @return {number} The week day in month.
+ */
+export function getWeekDayInMonth() {
+    const thisWeek = this.getWeek();
+    const first = this.setDate(1);
+    const firstWeek = first.getWeek();
+    const offset = first.getWeekDay() > this.getWeekDay() ?
+        0 : 1;
+    return firstWeek > thisWeek ?
+        thisWeek + offset :
+        thisWeek - firstWeek + offset;
+};
+
+/**
+ * Get the week of month in current timeZone.
+ * @return {number} The week of month.
+ */
+export function getWeekOfMonth() {
+    const thisWeek = this.getWeek();
+    const firstWeek = this.setDate(1).getWeek();
+    return firstWeek > thisWeek ?
+        thisWeek + 1 :
+        thisWeek - firstWeek + 1;
+};
+
+/**
+ * Get the week year in current timeZone.
+ * @return {number} The week year.
+ */
+export function getWeekYear() {
+    const minDays = minimumDays(this.getLocale());
+    return this.setWeekDay(7 - minDays + 1).getYear();
+};
+
+/**
+ * Get the year in current timeZone.
+ * @return {number} The year.
+ */
+export function getYear() {
+    return new Date(getOffsetTime(this)).getUTCFullYear();
+};

package/src/prototype/attributes-set.js

@@ -0,0 +1,281 @@
+import DateTime from './../date-time.js';
+import { getOffsetTime, setOffsetTime } from './../helpers.js';
+import { config } from './../vars.js';
+import { minimumDays } from './../formatter/utility.js';
+import { daysInMonth } from './../static/utility.js';
+
+/**
+ * DateTime Attributes (Set)
+ */
+
+/**
+ * Set the date of the month in current timeZone.
+ * @param {number} date The date of the month.
+ * @return {DateTime} The DateTime object.
+ */
+export function setDate(date) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCDate(date),
+    );
+};
+
+/**
+ * Set the day of the week in current timeZone.
+ * @param {number} day The day of the week. (0 - Sunday, 6 - Saturday)
+ * @return {DateTime} The DateTime object.
+ */
+export function setDay(day) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCDate(
+            this.getDate() -
+            this.getDay() +
+            parseInt(day),
+        ),
+    );
+};
+
+/**
+ * Set the day of the year in current timeZone.
+ * @param {number} day The day of the year. (1, 366)
+ * @return {DateTime} The DateTime object.
+ */
+export function setDayOfYear(day) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCMonth(
+            0,
+            day,
+        ),
+    );
+};
+
+/**
+ * Set the hours in current timeZone (and optionally, minutes, seconds and milliseconds).
+ * @param {number} hours The hours. (0, 23)
+ * @param {number} [minutes] The minutes. (0, 59)
+ * @param {number} [seconds] The seconds. (0, 59)
+ * @param {number} [milliseconds] The milliseconds.
+ * @return {DateTime} The DateTime object.
+ */
+export function setHours(...args) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCHours(...args),
+    );
+};
+
+/**
+ * Set the milliseconds in current timeZone.
+ * @param {number} milliseconds The milliseconds.
+ * @return {DateTime} The DateTime object.
+ */
+export function setMilliseconds(milliseconds) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCMilliseconds(milliseconds),
+    );
+};
+
+/**
+ * Set the minutes in current timeZone (and optionally, seconds and milliseconds).
+ * @param {number} minutes The minutes. (0, 59)
+ * @param {number} [seconds] The seconds. (0, 59)
+ * @param {number} [milliseconds] The milliseconds.
+ * @return {DateTime} The DateTime object.
+ */
+export function setMinutes(...args) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCMinutes(...args),
+    );
+};
+
+/**
+ * Set the month in current timeZone (and optionally, date).
+ * @param {number} month The month. (1, 12)
+ * @param {number|null} [date] The date of the month.
+ * @return {DateTime} The DateTime object.
+ */
+export function setMonth(month, date = null) {
+    if (date === null) {
+        date = this.getDate();
+
+        if (config.clampDates) {
+            date = Math.min(
+                date,
+                daysInMonth(
+                    this.getYear(),
+                    month,
+                ),
+            );
+        }
+    }
+
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCMonth(
+            month - 1,
+            date,
+        ),
+    );
+};
+
+/**
+ * Set the quarter of the year in current timeZone.
+ * @param {number} quarter The quarter of the year. (1, 4)
+ * @return {DateTime} The DateTime object.
+ */
+export function setQuarter(quarter) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCMonth(
+            quarter * 3 -
+            3,
+        ),
+    );
+};
+
+/**
+ * Set the seconds in current timeZone (and optionally, milliseconds).
+ * @param {number} seconds The seconds. (0, 59)
+ * @param {number} [milliseconds] The milliseconds.
+ * @return {DateTime} The DateTime object.
+ */
+export function setSeconds(...args) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCSeconds(...args),
+    );
+};
+
+/**
+ * Set the number of seconds since the UNIX epoch.
+ * @param {number} timestamp The number of seconds since the UNIX epoch.
+ * @return {DateTime} The DateTime object.
+ */
+export function setTimestamp(timestamp) {
+    return this.setTime(timestamp * 1000);
+};
+
+/**
+ * Set the local day of the week in current timeZone (and optionally, day of the week).
+ * @param {number} week The local week.
+ * @param {number|null} [day] The local day of the week. (1 - 7)
+ * @return {DateTime} The DateTime object.
+ */
+export function setWeek(week, day = null) {
+    if (day === null) {
+        day = this.getWeekDay();
+    }
+
+    const minDays = minimumDays(this.getLocale());
+    return this.setYear(this.getWeekYear(), 1, minDays + ((week - 1) * 7)).setWeekDay(day);
+};
+
+/**
+ * Set the local day of the week in current timeZone.
+ * @param {number} day The local day of the week. (1 - 7)
+ * @return {DateTime} The DateTime object.
+ */
+export function setWeekDay(day) {
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCDate(
+            this.getDate() -
+            this.getWeekDay() +
+            parseInt(day),
+        ),
+    );
+};
+
+/**
+ * Set the week day in month in current timeZone.
+ * @param {number} week The week day in month.
+ * @return {DateTime} The DateTime object.
+ */
+export function setWeekDayInMonth(week) {
+    return this.setDate(
+        this.getDate() +
+        (
+            week -
+            this.getWeekDayInMonth()
+        ) * 7,
+    );
+};
+
+/**
+ * Set the week of month in current timeZone.
+ * @param {number} week The week of month.
+ * @return {DateTime} The DateTime object.
+ */
+export function setWeekOfMonth(week) {
+    return this.setDate(
+        this.getDate() +
+        (
+            week -
+            this.getWeekOfMonth()
+        ) * 7,
+    );
+};
+
+/**
+ * Set the local day of the week in current timeZone (and optionally, week and day of the week).
+ * @param {number} year The local year.
+ * @param {number|null} [week] The local week.
+ * @param {number|null} [day] The local day of the week. (1 - 7)
+ * @return {DateTime} The DateTime object.
+ */
+export function setWeekYear(year, week = null, day = null) {
+    const minDays = minimumDays(this.getLocale());
+
+    if (week === null) {
+        week = Math.min(
+            this.getWeek(),
+            DateTime.fromArray([year, 1, minDays]).weeksInYear(),
+        );
+    }
+
+    if (day === null) {
+        day = this.getWeekDay();
+    }
+
+    return this.setYear(year, 1, minDays + ((week - 1) * 7)).setWeekDay(day);
+};
+
+/**
+ * Set the year in current timeZone (and optionally, month and date).
+ * @param {number} year The year.
+ * @param {number|null} [month] The month. (1, 12)
+ * @param {number|null} [date] The date of the month.
+ * @return {DateTime} The DateTime object.
+ */
+export function setYear(year, month = null, date = null) {
+    if (month === null) {
+        month = this.getMonth();
+    }
+
+    if (date === null) {
+        date = this.getDate();
+
+        if (config.clampDates) {
+            date = Math.min(
+                date,
+                daysInMonth(
+                    this.getYear(),
+                    month,
+                ),
+            );
+        }
+    }
+
+    return setOffsetTime(
+        this,
+        new Date(getOffsetTime(this)).setUTCFullYear(
+            year,
+            month - 1,
+            date,
+        ),
+    );
+};

package/src/prototype/manipulate.js

@@ -0,0 +1,96 @@
+import { modify } from './../helpers.js';
+import { daysInMonth } from './../static/utility.js';
+
+/**
+ * DateTime Manipulation
+ */
+
+/**
+ * Add a duration to the date.
+ * @param {number} amount The amount to modify the date by.
+ * @param {string} timeUnit The unit of time.
+ * @return {DateTime} The DateTime object.
+ */
+export function add(amount, timeUnit) {
+    return modify(this, amount, timeUnit);
+};
+
+/**
+ * Modify the DateTime by setting it to the end of a unit of time.
+ * @param {string} timeUnit The unit of time.
+ * @return {DateTime} The DateTime object.
+ */
+export function endOf(timeUnit) {
+    timeUnit = timeUnit.toLowerCase();
+
+    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');
+    }
+};
+
+/**
+ * Modify the DateTime by setting it to the start of a unit of time.
+ * @param {string} timeUnit The unit of time.
+ * @return {DateTime} The DateTime object.
+ */
+export function startOf(timeUnit) {
+    timeUnit = timeUnit.toLowerCase();
+
+    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 duration from the date.
+ * @param {number} amount The amount to modify the date by.
+ * @param {string} timeUnit The unit of time.
+ * @return {DateTime} The DateTime object.
+ */
+export function sub(amount, timeUnit) {
+    return modify(this, -amount, timeUnit);
+};

package/src/prototype/output.js

@@ -0,0 +1,89 @@
+import { formats, formatTokenRegExp } from './../vars.js';
+import tokens from './../formatter/tokens.js';
+
+/**
+ * DateTime Output
+ */
+
+/**
+ * Format the current date using a format string.
+ * @param {string} formatString The format string.
+ * @return {string} The formatted date string.
+ */
+export function format(formatString) {
+    let match;
+    let output = '';
+
+    while (formatString && (match = formatString.match(formatTokenRegExp))) {
+        const token = match[1];
+        const position = match.index;
+        const length = match[0].length;
+
+        if (position) {
+            output += formatString.substring(0, position);
+        }
+
+        formatString = formatString.substring(position + length);
+
+        if (!token) {
+            output += match[0].slice(1, -1);
+            continue;
+        }
+
+        if (!(token in tokens)) {
+            throw new Error(`Invalid token in DateTime format: ${token}`);
+        }
+
+        output += tokens[token].output(this, length);
+    }
+
+    output += formatString;
+
+    return output;
+};
+
+/**
+ * Format the current date using "eee MMM dd yyyy".
+ * @return {string} The formatted date string.
+ */
+export function toDateString() {
+    return this.format(formats.date);
+};
+
+/**
+ * Format the current date using "yyyy-MM-dd'THH:mm:ss.SSSSSSxxx".
+ * @return {string} The formatted date string.
+ */
+export function toISOString() {
+    return this
+        .setLocale('en')
+        .setTimeZone('UTC')
+        .format(formats.rfc3339_extended);
+};
+
+/**
+ * Format the current date using "eee MMM dd yyyy HH:mm:ss xx (VV)".
+ * @return {string} The formatted date string.
+ */
+export function toString() {
+    return this.format(formats.string);
+};
+
+/**
+ * Format the current date using "HH:mm:ss xx (VV)".
+ * @return {string} The formatted date string.
+ */
+export function toTimeString() {
+    return this.format(formats.time);
+};
+
+/**
+ * Format the current date in UTC timeZone using "eee MMM dd yyyy HH:mm:ss xx (VV)".
+ * @return {string} The formatted date string.
+ */
+export function toUTCString() {
+    return this
+        .setLocale('en')
+        .setTimeZone('UTC')
+        .toString();
+};