@fr0st/datetime 7.0.0 → 8.0.1

package/src/date-time.js

@@ -50,7 +50,7 @@ export default class DateTime {
      * @param {number} year The year.
      * @param {number} month The month. (1-12)
      * @param {number} date The date.
-     * @return {number} The day of the year. (1-366)
+     * @returns {number} The day of the year. (1-366)
      */
     static dayOfYear(year, month, date) {
         return new Array(month - 1)
@@ -66,7 +66,7 @@ export default class DateTime {
      * Gets the number of days in a month for a given year.
      * @param {number} year The year.
      * @param {number} month The month. (1-12)
-     * @return {number} The number of days in the month.
+     * @returns {number} The number of days in the month.
      */
     static daysInMonth(year, month) {
         const date = new Date(0);
@@ -86,7 +86,7 @@ export default class DateTime {
     /**
      * Gets the number of days in a given year.
      * @param {number} year The year.
-     * @return {number} The number of days in the year.
+     * @returns {number} The number of days in the year.
      */
     static daysInYear(year) {
         return !this.isLeapYear(year) ?
@@ -101,7 +101,7 @@ export default class DateTime {
      * @param {DateTimeOptions} [options={}] Options for the new DateTime.
      * @param {string} [options.timeZone] The time zone to use.
      * @param {string} [options.locale] The locale to use.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     static fromArray(dateArray, options = {}) {
         const dateValues = dateArray.slice(0, 3);
@@ -127,7 +127,7 @@ export default class DateTime {
      * @param {DateTimeOptions} [options={}] Options for the new DateTime.
      * @param {string} [options.timeZone] The time zone to use.
      * @param {string} [options.locale] The locale to use.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     static fromDate(date, options = {}) {
         return new this(date.getTime(), options);
@@ -140,9 +140,9 @@ export default class DateTime {
      * @param {DateTimeOptions} [options={}] Options for the new DateTime.
      * @param {string} [options.timeZone] The time zone to use.
      * @param {string} [options.locale] The locale to use.
-     * @throws {Error} Throws when the format contains unsupported parsing tokens such as
+     * @returns {DateTime} A new DateTime instance.
+     * @throws {Error} When the format contains unsupported parsing tokens such as
      * `MMMMM` or `LLLLL`.
-     * @return {DateTime} A new DateTime instance.
      */
     static fromFormat(formatString, dateString, options = {}) {
         const locale = 'locale' in options ?
@@ -290,7 +290,7 @@ export default class DateTime {
      * @param {DateTimeOptions} [options={}] Options for the new DateTime.
      * @param {string} [options.timeZone] The time zone to use.
      * @param {string} [options.locale] The locale to use.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     static fromISOString(dateString, options = {}) {
         let date = this.fromFormat(formats.rfc3339_extended, dateString, {
@@ -314,7 +314,7 @@ export default class DateTime {
      * @param {DateTimeOptions} [options={}] Options for the new DateTime.
      * @param {string} [options.timeZone] The time zone to use.
      * @param {string} [options.locale] The locale to use.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     static fromTimestamp(timestamp, options = {}) {
         return new this(null, options)
@@ -323,7 +323,7 @@ export default class DateTime {
 
     /**
      * Gets the default locale.
-     * @return {string} The locale.
+     * @returns {string} The locale.
      */
     static getDefaultLocale() {
         return config.defaultLocale;
@@ -331,7 +331,7 @@ export default class DateTime {
 
     /**
      * Gets the default time zone.
-     * @return {string} The default time zone.
+     * @returns {string} The default time zone.
      */
     static getDefaultTimeZone() {
         return config.defaultTimeZone;
@@ -340,7 +340,7 @@ export default class DateTime {
     /**
      * Checks whether the year is a leap year.
      * @param {number} year The year.
-     * @return {boolean} Whether the given year is a leap year.
+     * @returns {boolean} Whether the given year is a leap year.
      */
     static isLeapYear(year) {
         const date = new Date(0);
@@ -354,7 +354,7 @@ export default class DateTime {
      * @param {DateTimeOptions} [options={}] Options for the new DateTime.
      * @param {string} [options.timeZone] The time zone to use.
      * @param {string} [options.locale] The locale to use.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     static now(options = {}) {
         return new this(null, options);
@@ -473,7 +473,7 @@ export default class DateTime {
 
     /**
      * Adds a day to the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addDay() {
         return this.addDays(1);
@@ -482,7 +482,7 @@ export default class DateTime {
     /**
      * Adds days to the current DateTime.
      * @param {number} amount The number of days to add.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addDays(amount) {
         return setOffsetTime(
@@ -496,7 +496,7 @@ export default class DateTime {
 
     /**
      * Adds an hour to the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addHour() {
         return this.addHours(1);
@@ -505,7 +505,7 @@ export default class DateTime {
     /**
      * Adds hours to the current DateTime.
      * @param {number} amount The number of hours to add.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addHours(amount) {
         return this.withTime(
@@ -515,7 +515,7 @@ export default class DateTime {
 
     /**
      * Adds a minute to the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addMinute() {
         return this.addMinutes(1);
@@ -524,7 +524,7 @@ export default class DateTime {
     /**
      * Adds minutes to the current DateTime.
      * @param {number} amount The number of minutes to add.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addMinutes(amount) {
         return this.withTime(
@@ -534,7 +534,7 @@ export default class DateTime {
 
     /**
      * Adds a month to the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addMonth() {
         return this.addMonths(1);
@@ -543,7 +543,7 @@ export default class DateTime {
     /**
      * Adds months to the current DateTime.
      * @param {number} amount The number of months to add.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addMonths(amount) {
         return this.withMonth(
@@ -553,7 +553,7 @@ export default class DateTime {
 
     /**
      * Adds a second to the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addSecond() {
         return this.addSeconds(1);
@@ -562,7 +562,7 @@ export default class DateTime {
     /**
      * Adds seconds to the current DateTime.
      * @param {number} amount The number of seconds to add.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addSeconds(amount) {
         return this.withTime(
@@ -572,7 +572,7 @@ export default class DateTime {
 
     /**
      * Adds a week to the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addWeek() {
         return this.addWeeks(1);
@@ -581,7 +581,7 @@ export default class DateTime {
     /**
      * Adds weeks to the current DateTime.
      * @param {number} amount The number of weeks to add.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addWeeks(amount) {
         return this.withDate(
@@ -591,7 +591,7 @@ export default class DateTime {
 
     /**
      * Adds a year to the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addYear() {
         return this.addYears(1);
@@ -600,7 +600,7 @@ export default class DateTime {
     /**
      * Adds years to the current DateTime.
      * @param {number} amount The number of years to add.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     addYears(amount) {
         return this.withYear(
@@ -611,7 +611,7 @@ export default class DateTime {
     /**
      * Gets the localized day name for the current date.
      * @param {'long'|'short'|'narrow'} [type='long'] The type of day name to return.
-     * @return {string} The localized day name.
+     * @returns {string} The localized day name.
      */
     dayName(type = 'long') {
         return formatDay(this.getLocale(), this.getDay(), type);
@@ -620,7 +620,7 @@ export default class DateTime {
     /**
      * Gets the localized day period for the current time.
      * @param {'long'|'short'|'narrow'} [type='long'] The type of day period to return.
-     * @return {string} The localized day period.
+     * @returns {string} The localized day period.
      */
     dayPeriod(type = 'long') {
         return formatDayPeriod(
@@ -634,7 +634,7 @@ export default class DateTime {
 
     /**
      * Gets the number of days in the current month.
-     * @return {number} The number of days in the current month.
+     * @returns {number} The number of days in the current month.
      */
     daysInMonth() {
         return this.constructor.daysInMonth(
@@ -645,7 +645,7 @@ export default class DateTime {
 
     /**
      * Gets the number of days in the current year.
-     * @return {number} The number of days in the current year.
+     * @returns {number} The number of days in the current year.
      */
     daysInYear() {
         return this.constructor.daysInYear(
@@ -656,7 +656,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in milliseconds.
      * @param {DateTime} other The date to compare to.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diff(other) {
         return this - other;
@@ -666,7 +666,7 @@ export default class DateTime {
      * Gets the difference between this and another Date in days.
      * @param {DateTime} other The date to compare to.
      * @param {{relative?: boolean}} [options] Options for comparing the dates.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diffInDays(other, { relative = true } = {}) {
         return calculateDiff(this, other, 'day', relative);
@@ -676,7 +676,7 @@ export default class DateTime {
      * Gets the difference between this and another Date in hours.
      * @param {DateTime} other The date to compare to.
      * @param {{relative?: boolean}} [options] Options for comparing the dates.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diffInHours(other, { relative = true } = {}) {
         return calculateDiff(this, other, 'hour', relative);
@@ -686,7 +686,7 @@ export default class DateTime {
      * Gets the difference between this and another Date in minutes.
      * @param {DateTime} other The date to compare to.
      * @param {{relative?: boolean}} [options] Options for comparing the dates.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diffInMinutes(other, { relative = true } = {}) {
         return calculateDiff(this, other, 'minute', relative);
@@ -696,7 +696,7 @@ export default class DateTime {
      * Gets the difference between this and another Date in months.
      * @param {DateTime} other The date to compare to.
      * @param {{relative?: boolean}} [options] Options for comparing the dates.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diffInMonths(other, { relative = true } = {}) {
         return calculateDiff(this, other, 'month', relative);
@@ -706,7 +706,7 @@ export default class DateTime {
      * Gets the difference between this and another Date in seconds.
      * @param {DateTime} other The date to compare to.
      * @param {{relative?: boolean}} [options] Options for comparing the dates.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diffInSeconds(other, { relative = true } = {}) {
         return calculateDiff(this, other, 'second', relative);
@@ -716,7 +716,7 @@ export default class DateTime {
      * Gets the difference between this and another Date in weeks.
      * @param {DateTime} other The date to compare to.
      * @param {{relative?: boolean}} [options] Options for comparing the dates.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diffInWeeks(other, { relative = true } = {}) {
         return calculateDiff(this, other, 'week', relative);
@@ -726,7 +726,7 @@ export default class DateTime {
      * Gets the difference between this and another Date in years.
      * @param {DateTime} other The date to compare to.
      * @param {{relative?: boolean}} [options] Options for comparing the dates.
-     * @return {number} The difference.
+     * @returns {number} The difference.
      */
     diffInYears(other, { relative = true } = {}) {
         return calculateDiff(this, other, 'year', relative);
@@ -734,7 +734,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the day.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfDay() {
         return this.withHours(23, 59, 59, 999);
@@ -742,7 +742,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the hour.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfHour() {
         return this.withMinutes(59, 59, 999);
@@ -750,7 +750,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the minute.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfMinute() {
         return this.withSeconds(59, 999);
@@ -758,7 +758,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the month.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfMonth() {
         return this.withDate(this.daysInMonth())
@@ -767,7 +767,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the quarter.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfQuarter() {
         const month = this.getQuarter() * 3;
@@ -777,7 +777,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the second.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfSecond() {
         return this.withMilliseconds(999);
@@ -785,7 +785,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the week.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfWeek() {
         return this.withWeekDay(7)
@@ -794,7 +794,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the end of the year.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     endOfYear() {
         return this.withMonth(12, 31)
@@ -804,7 +804,7 @@ export default class DateTime {
     /**
      * Gets the localized era for the current date.
      * @param {'long'|'short'|'narrow'} [type='long'] The type of era to return.
-     * @return {string} The localized era.
+     * @returns {string} The localized era.
      */
     era(type = 'long') {
         return formatEra(
@@ -819,7 +819,7 @@ export default class DateTime {
     /**
      * Formats the current date using a format string.
      * @param {string} formatString The format string.
-     * @return {string} The formatted date string.
+     * @returns {string} The formatted date string.
      */
     format(formatString) {
         let match;
@@ -859,7 +859,7 @@ export default class DateTime {
 
     /**
      * Gets the date of the month in the current time zone.
-     * @return {number} The date of the month.
+     * @returns {number} The date of the month.
      */
     getDate() {
         return new Date(getOffsetTime(this)).getUTCDate();
@@ -867,7 +867,7 @@ export default class DateTime {
 
     /**
      * Gets the day of the week in the current time zone.
-     * @return {number} The day of the week. (0 = Sunday, 6 = Saturday)
+     * @returns {number} The day of the week. (0 = Sunday, 6 = Saturday)
      */
     getDay() {
         return new Date(getOffsetTime(this)).getUTCDay();
@@ -875,7 +875,7 @@ export default class DateTime {
 
     /**
      * Gets the day of the year in the current time zone.
-     * @return {number} The day of the year. (1-366)
+     * @returns {number} The day of the year. (1-366)
      */
     getDayOfYear() {
         return this.constructor.dayOfYear(
@@ -887,7 +887,7 @@ export default class DateTime {
 
     /**
      * Gets the hours of the day in the current time zone.
-     * @return {number} The hours of the day. (0-23)
+     * @returns {number} The hours of the day. (0-23)
      */
     getHours() {
         return new Date(getOffsetTime(this)).getUTCHours();
@@ -895,7 +895,7 @@ export default class DateTime {
 
     /**
      * Gets the current locale.
-     * @return {string} The locale.
+     * @returns {string} The locale.
      */
     getLocale() {
         return this._locale;
@@ -903,7 +903,7 @@ export default class DateTime {
 
     /**
      * Gets the milliseconds in the current time zone.
-     * @return {number} The milliseconds.
+     * @returns {number} The milliseconds.
      */
     getMilliseconds() {
         return new Date(getOffsetTime(this)).getUTCMilliseconds();
@@ -911,7 +911,7 @@ export default class DateTime {
 
     /**
      * Gets the minutes in the current time zone.
-     * @return {number} The minutes. (0-59)
+     * @returns {number} The minutes. (0-59)
      */
     getMinutes() {
         return new Date(getOffsetTime(this)).getUTCMinutes();
@@ -919,7 +919,7 @@ export default class DateTime {
 
     /**
      * Gets the month in the current time zone.
-     * @return {number} The month. (1-12)
+     * @returns {number} The month. (1-12)
      */
     getMonth() {
         return new Date(getOffsetTime(this)).getUTCMonth() + 1;
@@ -927,7 +927,7 @@ export default class DateTime {
 
     /**
      * Gets the quarter of the year in the current time zone.
-     * @return {number} The quarter of the year. (1-4)
+     * @returns {number} The quarter of the year. (1-4)
      */
     getQuarter() {
         return Math.ceil(this.getMonth() / 3);
@@ -935,7 +935,7 @@ export default class DateTime {
 
     /**
      * Gets the seconds in the current time zone.
-     * @return {number} The seconds. (0-59)
+     * @returns {number} The seconds. (0-59)
      */
     getSeconds() {
         return new Date(getOffsetTime(this)).getUTCSeconds();
@@ -943,7 +943,7 @@ export default class DateTime {
 
     /**
      * Gets the number of milliseconds since the UNIX epoch.
-     * @return {number} The number of milliseconds since the UNIX epoch.
+     * @returns {number} The number of milliseconds since the UNIX epoch.
      */
     getTime() {
         return this._date.getTime();
@@ -951,7 +951,7 @@ export default class DateTime {
 
     /**
      * Gets the number of seconds since the UNIX epoch.
-     * @return {number} The number of seconds since the UNIX epoch.
+     * @returns {number} The number of seconds since the UNIX epoch.
      */
     getTimestamp() {
         return Math.floor(this.getTime() / 1000);
@@ -959,7 +959,7 @@ export default class DateTime {
 
     /**
      * Gets the current time zone.
-     * @return {string} The time zone.
+     * @returns {string} The time zone.
      */
     getTimeZone() {
         return this._timeZone;
@@ -967,7 +967,7 @@ export default class DateTime {
 
     /**
      * Gets the current UTC offset in minutes.
-     * @return {number} The UTC offset in minutes.
+     * @returns {number} The UTC offset in minutes.
      */
     getTimeZoneOffset() {
         return this._offset;
@@ -975,7 +975,7 @@ export default class DateTime {
 
     /**
      * Gets the local week in the current time zone.
-     * @return {number} The local week. (1-53)
+     * @returns {number} The local week. (1-53)
      */
     getWeek() {
         const thisWeek = this.startOfDay().withWeekDay(1);
@@ -989,7 +989,7 @@ export default class DateTime {
 
     /**
      * Gets the local day of the week in the current time zone.
-     * @return {number} The local day of the week. (1-7)
+     * @returns {number} The local day of the week. (1-7)
      */
     getWeekDay() {
         return weekDay(
@@ -1000,7 +1000,7 @@ export default class DateTime {
 
     /**
      * Gets the week day in month in the current time zone.
-     * @return {number} The week day in month.
+     * @returns {number} The week day in month.
      */
     getWeekDayInMonth() {
         const thisWeek = this.getWeek();
@@ -1015,7 +1015,7 @@ export default class DateTime {
 
     /**
      * Gets the week of month in the current time zone.
-     * @return {number} The week of month.
+     * @returns {number} The week of month.
      */
     getWeekOfMonth() {
         const thisWeek = this.getWeek();
@@ -1027,7 +1027,7 @@ export default class DateTime {
 
     /**
      * Gets the week year in the current time zone.
-     * @return {number} The week year.
+     * @returns {number} The week year.
      */
     getWeekYear() {
         const minDays = minimumDays(this.getLocale());
@@ -1036,7 +1036,7 @@ export default class DateTime {
 
     /**
      * Gets the year in the current time zone.
-     * @return {number} The year.
+     * @returns {number} The year.
      */
     getYear() {
         return new Date(getOffsetTime(this)).getUTCFullYear();
@@ -1045,7 +1045,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in human readable form.
+     * @returns {string} The difference in human readable form.
      */
     humanDiff(other) {
         const [amount, unit] = getBiggestDiff(this, other);
@@ -1055,7 +1055,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in days in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in days in human readable form.
+     * @returns {string} The difference in days in human readable form.
      */
     humanDiffInDays(other) {
         return formatRelative(this.getLocale(), this.diffInDays(other), 'day');
@@ -1064,7 +1064,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in hours in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in hours in human readable form.
+     * @returns {string} The difference in hours in human readable form.
      */
     humanDiffInHours(other) {
         return formatRelative(this.getLocale(), this.diffInHours(other), 'hour');
@@ -1073,7 +1073,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in minutes in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in minutes in human readable form.
+     * @returns {string} The difference in minutes in human readable form.
      */
     humanDiffInMinutes(other) {
         return formatRelative(this.getLocale(), this.diffInMinutes(other), 'minute');
@@ -1082,7 +1082,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in months in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in months in human readable form.
+     * @returns {string} The difference in months in human readable form.
      */
     humanDiffInMonths(other) {
         return formatRelative(this.getLocale(), this.diffInMonths(other), 'month');
@@ -1091,7 +1091,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in seconds in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in seconds in human readable form.
+     * @returns {string} The difference in seconds in human readable form.
      */
     humanDiffInSeconds(other) {
         return formatRelative(this.getLocale(), this.diffInSeconds(other), 'second');
@@ -1100,7 +1100,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in weeks in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in weeks in human readable form.
+     * @returns {string} The difference in weeks in human readable form.
      */
     humanDiffInWeeks(other) {
         return formatRelative(this.getLocale(), this.diffInWeeks(other), 'week');
@@ -1109,7 +1109,7 @@ export default class DateTime {
     /**
      * Gets the difference between this and another Date in years in human readable form.
      * @param {DateTime} other The date to compare to.
-     * @return {string} The difference in years in human readable form.
+     * @returns {string} The difference in years in human readable form.
      */
     humanDiffInYears(other) {
         return formatRelative(this.getLocale(), this.diffInYears(other), 'year');
@@ -1118,7 +1118,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date.
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date.
+     * @returns {boolean} Whether this DateTime is after the other date.
      */
     isAfter(other) {
         return this.diff(other) > 0;
@@ -1127,7 +1127,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date (comparing by day).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date (comparing by day).
+     * @returns {boolean} Whether this DateTime is after the other date (comparing by day).
      */
     isAfterDay(other) {
         return this.diffInDays(other) > 0;
@@ -1136,7 +1136,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date (comparing by hour).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date (comparing by hour).
+     * @returns {boolean} Whether this DateTime is after the other date (comparing by hour).
      */
     isAfterHour(other) {
         return this.diffInHours(other) > 0;
@@ -1145,7 +1145,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date (comparing by minute).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date (comparing by minute).
+     * @returns {boolean} Whether this DateTime is after the other date (comparing by minute).
      */
     isAfterMinute(other) {
         return this.diffInMinutes(other) > 0;
@@ -1154,7 +1154,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date (comparing by month).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date (comparing by month).
+     * @returns {boolean} Whether this DateTime is after the other date (comparing by month).
      */
     isAfterMonth(other) {
         return this.diffInMonths(other) > 0;
@@ -1163,7 +1163,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date (comparing by second).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date (comparing by second).
+     * @returns {boolean} Whether this DateTime is after the other date (comparing by second).
      */
     isAfterSecond(other) {
         return this.diffInSeconds(other) > 0;
@@ -1172,7 +1172,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date (comparing by week).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date (comparing by week).
+     * @returns {boolean} Whether this DateTime is after the other date (comparing by week).
      */
     isAfterWeek(other) {
         return this.diffInWeeks(other) > 0;
@@ -1181,7 +1181,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is after another date (comparing by year).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is after the other date (comparing by year).
+     * @returns {boolean} Whether this DateTime is after the other date (comparing by year).
      */
     isAfterYear(other) {
         return this.diffInYears(other) > 0;
@@ -1190,7 +1190,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date.
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date.
+     * @returns {boolean} Whether this DateTime is before the other date.
      */
     isBefore(other) {
         return this.diff(other) < 0;
@@ -1199,7 +1199,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date (comparing by day).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date (comparing by day).
+     * @returns {boolean} Whether this DateTime is before the other date (comparing by day).
      */
     isBeforeDay(other) {
         return this.diffInDays(other) < 0;
@@ -1208,7 +1208,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date (comparing by hour).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date (comparing by hour).
+     * @returns {boolean} Whether this DateTime is before the other date (comparing by hour).
      */
     isBeforeHour(other) {
         return this.diffInHours(other) < 0;
@@ -1217,7 +1217,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date (comparing by minute).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date (comparing by minute).
+     * @returns {boolean} Whether this DateTime is before the other date (comparing by minute).
      */
     isBeforeMinute(other) {
         return this.diffInMinutes(other) < 0;
@@ -1226,7 +1226,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date (comparing by month).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date (comparing by month).
+     * @returns {boolean} Whether this DateTime is before the other date (comparing by month).
      */
     isBeforeMonth(other) {
         return this.diffInMonths(other) < 0;
@@ -1235,7 +1235,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date (comparing by second).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date (comparing by second).
+     * @returns {boolean} Whether this DateTime is before the other date (comparing by second).
      */
     isBeforeSecond(other) {
         return this.diffInSeconds(other) < 0;
@@ -1244,7 +1244,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date (comparing by week).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date (comparing by week).
+     * @returns {boolean} Whether this DateTime is before the other date (comparing by week).
      */
     isBeforeWeek(other) {
         return this.diffInWeeks(other) < 0;
@@ -1253,7 +1253,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is before another date (comparing by year).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is before the other date (comparing by year).
+     * @returns {boolean} Whether this DateTime is before the other date (comparing by year).
      */
     isBeforeYear(other) {
         return this.diffInYears(other) < 0;
@@ -1263,7 +1263,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates.
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates.
+     * @returns {boolean} Whether this DateTime is between two other dates.
      */
     isBetween(start, end) {
         return this.isAfter(start) && this.isBefore(end);
@@ -1273,7 +1273,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates (comparing by day).
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates (comparing by day).
+     * @returns {boolean} Whether this DateTime is between two other dates (comparing by day).
      */
     isBetweenDay(start, end) {
         return this.isAfterDay(start) && this.isBeforeDay(end);
@@ -1283,7 +1283,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates (comparing by hour).
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates (comparing by hour).
+     * @returns {boolean} Whether this DateTime is between two other dates (comparing by hour).
      */
     isBetweenHour(start, end) {
         return this.isAfterHour(start) && this.isBeforeHour(end);
@@ -1293,7 +1293,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates (comparing by minute).
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates (comparing by minute).
+     * @returns {boolean} Whether this DateTime is between two other dates (comparing by minute).
      */
     isBetweenMinute(start, end) {
         return this.isAfterMinute(start) && this.isBeforeMinute(end);
@@ -1303,7 +1303,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates (comparing by month).
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates (comparing by month).
+     * @returns {boolean} Whether this DateTime is between two other dates (comparing by month).
      */
     isBetweenMonth(start, end) {
         return this.isAfterMonth(start) && this.isBeforeMonth(end);
@@ -1313,7 +1313,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates (comparing by second).
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates (comparing by second).
+     * @returns {boolean} Whether this DateTime is between two other dates (comparing by second).
      */
     isBetweenSecond(start, end) {
         return this.isAfterSecond(start) && this.isBeforeSecond(end);
@@ -1323,7 +1323,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates (comparing by week).
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates (comparing by week).
+     * @returns {boolean} Whether this DateTime is between two other dates (comparing by week).
      */
     isBetweenWeek(start, end) {
         return this.isAfterWeek(start) && this.isBeforeWeek(end);
@@ -1333,7 +1333,7 @@ export default class DateTime {
      * Checks whether this DateTime is between two other dates (comparing by year).
      * @param {DateTime} start The first date to compare to.
      * @param {DateTime} end The second date to compare to.
-     * @return {boolean} Whether this DateTime is between two other dates (comparing by year).
+     * @returns {boolean} Whether this DateTime is between two other dates (comparing by year).
      */
     isBetweenYear(start, end) {
         return this.isAfterYear(start) && this.isBeforeYear(end);
@@ -1341,7 +1341,7 @@ export default class DateTime {
 
     /**
      * Checks whether the DateTime is in daylight saving time.
-     * @return {boolean} Whether the current time is in daylight saving time.
+     * @returns {boolean} Whether the current time is in daylight saving time.
      */
     isDst() {
         if (!this._dynamicTz) {
@@ -1361,7 +1361,7 @@ export default class DateTime {
 
     /**
      * Checks whether the year is a leap year.
-     * @return {boolean} Whether the current year is a leap year.
+     * @returns {boolean} Whether the current year is a leap year.
      */
     isLeapYear() {
         return this.constructor.isLeapYear(
@@ -1372,7 +1372,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date.
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date.
+     * @returns {boolean} Whether this DateTime is the same as the other date.
      */
     isSame(other) {
         return this.diff(other) === 0;
@@ -1381,7 +1381,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date (comparing by day).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date (comparing by day).
+     * @returns {boolean} Whether this DateTime is the same as the other date (comparing by day).
      */
     isSameDay(other) {
         return this.diffInDays(other) === 0;
@@ -1390,7 +1390,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date (comparing by hour).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date (comparing by hour).
+     * @returns {boolean} Whether this DateTime is the same as the other date (comparing by hour).
      */
     isSameHour(other) {
         return this.diffInHours(other) === 0;
@@ -1399,7 +1399,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date (comparing by minute).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date (comparing by minute).
+     * @returns {boolean} Whether this DateTime is the same as the other date (comparing by minute).
      */
     isSameMinute(other) {
         return this.diffInMinutes(other) === 0;
@@ -1408,7 +1408,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date (comparing by month).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date (comparing by month).
+     * @returns {boolean} Whether this DateTime is the same as the other date (comparing by month).
      */
     isSameMonth(other) {
         return this.diffInMonths(other) === 0;
@@ -1417,7 +1417,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date.
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date.
+     * @returns {boolean} Whether this DateTime is the same as or after the other date.
      */
     isSameOrAfter(other) {
         return this.diff(other) >= 0;
@@ -1426,7 +1426,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date (comparing by day).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date (comparing by day).
+     * @returns {boolean} Whether this DateTime is the same as or after the other date (comparing by day).
      */
     isSameOrAfterDay(other) {
         return this.diffInDays(other) >= 0;
@@ -1435,7 +1435,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date (comparing by hour).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date (comparing by hour).
+     * @returns {boolean} Whether this DateTime is the same as or after the other date (comparing by hour).
      */
     isSameOrAfterHour(other) {
         return this.diffInHours(other) >= 0;
@@ -1444,7 +1444,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date (comparing by minute).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date (comparing by minute).
+     * @returns {boolean} Whether this DateTime is the same as or after the other date (comparing by minute).
      */
     isSameOrAfterMinute(other) {
         return this.diffInMinutes(other) >= 0;
@@ -1453,7 +1453,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date (comparing by month).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date (comparing by month).
+     * @returns {boolean} Whether this DateTime is the same as or after the other date (comparing by month).
      */
     isSameOrAfterMonth(other) {
         return this.diffInMonths(other) >= 0;
@@ -1462,7 +1462,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date (comparing by second).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date (comparing by second).
+     * @returns {boolean} Whether this DateTime is the same as or after the other date (comparing by second).
      */
     isSameOrAfterSecond(other) {
         return this.diffInSeconds(other) >= 0;
@@ -1471,7 +1471,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date (comparing by week).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date (comparing by week).
+     * @returns {boolean} Whether this DateTime is the same as or after the other date (comparing by week).
      */
     isSameOrAfterWeek(other) {
         return this.diffInWeeks(other) >= 0;
@@ -1480,7 +1480,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or after another date (comparing by year).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or after the other date (comparing by year).
+     * @returns {boolean} Whether this DateTime is the same as or after the other date (comparing by year).
      */
     isSameOrAfterYear(other) {
         return this.diffInYears(other) >= 0;
@@ -1489,7 +1489,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date.
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date.
+     * @returns {boolean} Whether this DateTime is the same as or before the other date.
      */
     isSameOrBefore(other) {
         return this.diff(other) <= 0;
@@ -1498,7 +1498,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date (comparing by day).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date (comparing by day).
+     * @returns {boolean} Whether this DateTime is the same as or before the other date (comparing by day).
      */
     isSameOrBeforeDay(other) {
         return this.diffInDays(other) <= 0;
@@ -1507,7 +1507,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date (comparing by hour).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date (comparing by hour).
+     * @returns {boolean} Whether this DateTime is the same as or before the other date (comparing by hour).
      */
     isSameOrBeforeHour(other) {
         return this.diffInHours(other) <= 0;
@@ -1516,7 +1516,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date (comparing by minute).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date (comparing by minute).
+     * @returns {boolean} Whether this DateTime is the same as or before the other date (comparing by minute).
      */
     isSameOrBeforeMinute(other) {
         return this.diffInMinutes(other) <= 0;
@@ -1525,7 +1525,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date (comparing by month).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date (comparing by month).
+     * @returns {boolean} Whether this DateTime is the same as or before the other date (comparing by month).
      */
     isSameOrBeforeMonth(other) {
         return this.diffInMonths(other) <= 0;
@@ -1534,7 +1534,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date (comparing by second).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date (comparing by second).
+     * @returns {boolean} Whether this DateTime is the same as or before the other date (comparing by second).
      */
     isSameOrBeforeSecond(other) {
         return this.diffInSeconds(other) <= 0;
@@ -1543,7 +1543,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date (comparing by week).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date (comparing by week).
+     * @returns {boolean} Whether this DateTime is the same as or before the other date (comparing by week).
      */
     isSameOrBeforeWeek(other) {
         return this.diffInWeeks(other) <= 0;
@@ -1552,7 +1552,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as or before another date (comparing by year).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as or before the other date (comparing by year).
+     * @returns {boolean} Whether this DateTime is the same as or before the other date (comparing by year).
      */
     isSameOrBeforeYear(other) {
         return this.diffInYears(other) <= 0;
@@ -1561,7 +1561,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date (comparing by second).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date (comparing by second).
+     * @returns {boolean} Whether this DateTime is the same as the other date (comparing by second).
      */
     isSameSecond(other) {
         return this.diffInSeconds(other) === 0;
@@ -1570,7 +1570,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date (comparing by week).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date (comparing by week).
+     * @returns {boolean} Whether this DateTime is the same as the other date (comparing by week).
      */
     isSameWeek(other) {
         return this.diffInWeeks(other) === 0;
@@ -1579,7 +1579,7 @@ export default class DateTime {
     /**
      * Checks whether this DateTime is the same as another date (comparing by year).
      * @param {DateTime} other The date to compare to.
-     * @return {boolean} Whether this DateTime is the same as the other date (comparing by year).
+     * @returns {boolean} Whether this DateTime is the same as the other date (comparing by year).
      */
     isSameYear(other) {
         return this.diffInYears(other) === 0;
@@ -1588,7 +1588,7 @@ export default class DateTime {
     /**
      * Gets the localized month name for the current date.
      * @param {'long'|'short'|'narrow'} [type='long'] The type of month name to return.
-     * @return {string} The localized month name.
+     * @returns {string} The localized month name.
      */
     monthName(type = 'long') {
         return formatMonth(this.getLocale(), this.getMonth(), type);
@@ -1596,7 +1596,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the day.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfDay() {
         return this.withHours(0, 0, 0, 0);
@@ -1604,7 +1604,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the hour.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfHour() {
         return this.withMinutes(0, 0, 0);
@@ -1612,7 +1612,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the minute.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfMinute() {
         return this.withSeconds(0, 0);
@@ -1620,7 +1620,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the month.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfMonth() {
         return this.withDate(1)
@@ -1629,7 +1629,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the quarter.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfQuarter() {
         const month = this.getQuarter() * 3 - 2;
@@ -1639,7 +1639,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the second.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfSecond() {
         return this.withMilliseconds(0);
@@ -1647,7 +1647,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the week.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfWeek() {
         return this.withWeekDay(1)
@@ -1656,7 +1656,7 @@ export default class DateTime {
 
     /**
      * Sets the DateTime to the start of the year.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     startOfYear() {
         return this.withMonth(1, 1)
@@ -1665,7 +1665,7 @@ export default class DateTime {
 
     /**
      * Subtracts a day from the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subDay() {
         return this.addDays(-1);
@@ -1674,7 +1674,7 @@ export default class DateTime {
     /**
      * Subtracts days from the current DateTime.
      * @param {number} amount The number of days to subtract.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subDays(amount) {
         return this.addDays(-amount);
@@ -1682,7 +1682,7 @@ export default class DateTime {
 
     /**
      * Subtracts an hour from the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subHour() {
         return this.addHours(-1);
@@ -1691,7 +1691,7 @@ export default class DateTime {
     /**
      * Subtracts hours from the current DateTime.
      * @param {number} amount The number of hours to subtract.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subHours(amount) {
         return this.addHours(-amount);
@@ -1699,7 +1699,7 @@ export default class DateTime {
 
     /**
      * Subtracts a minute from the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subMinute() {
         return this.addMinutes(-1);
@@ -1708,7 +1708,7 @@ export default class DateTime {
     /**
      * Subtracts minutes from the current DateTime.
      * @param {number} amount The number of minutes to subtract.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subMinutes(amount) {
         return this.addMinutes(-amount);
@@ -1716,7 +1716,7 @@ export default class DateTime {
 
     /**
      * Subtracts a month from the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subMonth() {
         return this.addMonths(-1);
@@ -1725,7 +1725,7 @@ export default class DateTime {
     /**
      * Subtracts months from the current DateTime.
      * @param {number} amount The number of months to subtract.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subMonths(amount) {
         return this.addMonths(-amount);
@@ -1733,7 +1733,7 @@ export default class DateTime {
 
     /**
      * Subtracts a second from the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subSecond() {
         return this.addSeconds(-1);
@@ -1742,7 +1742,7 @@ export default class DateTime {
     /**
      * Subtracts seconds from the current DateTime.
      * @param {number} amount The number of seconds to subtract.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subSeconds(amount) {
         return this.addSeconds(-amount);
@@ -1750,7 +1750,7 @@ export default class DateTime {
 
     /**
      * Subtracts a week from the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subWeek() {
         return this.addWeeks(-1);
@@ -1759,7 +1759,7 @@ export default class DateTime {
     /**
      * Subtracts weeks from the current DateTime.
      * @param {number} amount The number of weeks to subtract.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subWeeks(amount) {
         return this.addWeeks(-amount);
@@ -1767,7 +1767,7 @@ export default class DateTime {
 
     /**
      * Subtracts a year from the current DateTime.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subYear() {
         return this.addYears(-1);
@@ -1776,7 +1776,7 @@ export default class DateTime {
     /**
      * Subtracts years from the current DateTime.
      * @param {number} amount The number of years to subtract.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     subYears(amount) {
         return this.addYears(-amount);
@@ -1785,7 +1785,7 @@ export default class DateTime {
     /**
      * Returns the primitive representation of the DateTime.
      * @param {'default'|'number'|'string'} hint The conversion hint.
-     * @return {string|number} A string for default/string coercion or epoch milliseconds for numeric coercion.
+     * @returns {string|number} A string for default/string coercion or epoch milliseconds for numeric coercion.
      */
     [Symbol.toPrimitive](hint) {
         return hint === 'number' ?
@@ -1796,7 +1796,7 @@ export default class DateTime {
     /**
      * Gets the name of the current time zone.
      * @param {'long'|'short'} [type='long'] The formatting type.
-     * @return {string} The name of the time zone.
+     * @returns {string} The name of the time zone.
      */
     timeZoneName(type = 'long') {
         return this._dynamicTz ?
@@ -1806,7 +1806,7 @@ export default class DateTime {
 
     /**
      * Formats the current date using "eee MMM dd yyyy".
-     * @return {string} The formatted date string.
+     * @returns {string} The formatted date string.
      */
     toDateString() {
         return this.format(formats.date);
@@ -1814,9 +1814,9 @@ export default class DateTime {
 
     /**
      * Formats the current date using "yyyy-MM-dd'T'HH:mm:ss.SSSxxx".
-     * @return {string} The formatted date string.
+     * @returns {string} The formatted date string.
      */
-    toISOString() {
+    toIsoString() {
         return this
             .withLocale('en')
             .withTimeZone('UTC')
@@ -1825,17 +1825,17 @@ export default class DateTime {
 
     /**
      * Returns the JSON representation of the current date.
-     * @return {string|null} The ISO string for valid dates or null for invalid dates.
+     * @returns {string|null} The ISO string for valid dates or null for invalid dates.
      */
     toJSON() {
         return this.isValid ?
-            this.toISOString() :
+            this.toIsoString() :
             null;
     }
 
     /**
      * Formats the current date using "eee MMM dd yyyy HH:mm:ss xx (VV)".
-     * @return {string} The formatted date string.
+     * @returns {string} The formatted date string.
      */
     toString() {
         return this.format(formats.string);
@@ -1843,7 +1843,7 @@ export default class DateTime {
 
     /**
      * Formats the current date using "HH:mm:ss xx (VV)".
-     * @return {string} The formatted date string.
+     * @returns {string} The formatted date string.
      */
     toTimeString() {
         return this.format(formats.time);
@@ -1851,7 +1851,7 @@ export default class DateTime {
 
     /**
      * Formats the current date in the UTC time zone using "eee MMM dd yyyy HH:mm:ss xx (VV)".
-     * @return {string} The formatted date string.
+     * @returns {string} The formatted date string.
      */
     toUTCString() {
         return this
@@ -1862,7 +1862,7 @@ export default class DateTime {
 
     /**
      * Returns the number of milliseconds since the UNIX epoch.
-     * @return {number} The number of milliseconds since the UNIX epoch.
+     * @returns {number} The number of milliseconds since the UNIX epoch.
      */
     valueOf() {
         return this.getTime();
@@ -1870,7 +1870,7 @@ export default class DateTime {
 
     /**
      * Gets the number of weeks in the current year.
-     * @return {number} The number of weeks in the current year.
+     * @returns {number} The number of weeks in the current year.
      */
     weeksInYear() {
         const minDays = minimumDays(this.getLocale());
@@ -1880,7 +1880,7 @@ export default class DateTime {
     /**
      * Returns a copy with the date of the month changed in the current time zone.
      * @param {number} date The date of the month.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withDate(date) {
         return setOffsetTime(
@@ -1892,7 +1892,7 @@ export default class DateTime {
     /**
      * Returns a copy with the day of the week changed in the current time zone.
      * @param {number} day The day of the week. (0 = Sunday, 6 = Saturday)
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withDay(day) {
         return setOffsetTime(
@@ -1908,7 +1908,7 @@ export default class DateTime {
     /**
      * Returns a copy with the day of the year changed in the current time zone.
      * @param {number} day The day of the year. (1-366)
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withDayOfYear(day) {
         return setOffsetTime(
@@ -1926,7 +1926,7 @@ export default class DateTime {
      * @param {number} [minutes] The minutes. (0-59)
      * @param {number} [seconds] The seconds. (0-59)
      * @param {number} [milliseconds] The milliseconds.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withHours(...args) {
         return setOffsetTime(
@@ -1938,7 +1938,7 @@ export default class DateTime {
     /**
      * Returns a copy with a different locale.
      * @param {string} locale The locale to use.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withLocale(locale) {
         return new this.constructor(this.getTime(), {
@@ -1950,7 +1950,7 @@ export default class DateTime {
     /**
      * Returns a copy with the milliseconds changed in the current time zone.
      * @param {number} milliseconds The milliseconds.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withMilliseconds(milliseconds) {
         return setOffsetTime(
@@ -1964,7 +1964,7 @@ export default class DateTime {
      * @param {number} minutes The minutes. (0-59)
      * @param {number} [seconds] The seconds. (0-59)
      * @param {number} [milliseconds] The milliseconds.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withMinutes(...args) {
         return setOffsetTime(
@@ -1977,7 +1977,7 @@ export default class DateTime {
      * Returns a copy with the month changed in the current time zone.
      * @param {number} month The month. (1-12)
      * @param {number|null} [date] The date of the month.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withMonth(month, date = null) {
         if (date === null) {
@@ -2006,7 +2006,7 @@ export default class DateTime {
     /**
      * Returns a copy with the quarter of the year changed in the current time zone.
      * @param {number} quarter The quarter of the year. (1-4)
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withQuarter(quarter) {
         return setOffsetTime(
@@ -2022,7 +2022,7 @@ export default class DateTime {
      * Returns a copy with the seconds changed in the current time zone.
      * @param {number} seconds The seconds. (0-59)
      * @param {number} [milliseconds] The milliseconds.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withSeconds(...args) {
         return setOffsetTime(
@@ -2034,7 +2034,7 @@ export default class DateTime {
     /**
      * Returns a copy with a different epoch-millisecond value.
      * @param {number} time The number of milliseconds since the UNIX epoch.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withTime(time) {
         return new this.constructor(time, {
@@ -2046,7 +2046,7 @@ export default class DateTime {
     /**
      * Returns a copy with a different number of seconds since the UNIX epoch.
      * @param {number} timestamp The number of seconds since the UNIX epoch.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withTimestamp(timestamp) {
         return this.withTime(timestamp * 1000);
@@ -2055,7 +2055,7 @@ export default class DateTime {
     /**
      * Returns a copy in a different time zone.
      * @param {string} timeZone The time zone to use.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withTimeZone(timeZone) {
         return new this.constructor(this.getTime(), {
@@ -2067,7 +2067,7 @@ export default class DateTime {
     /**
      * Returns a copy with a fixed numeric UTC offset.
      * @param {number} offset The UTC offset in minutes.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withTimeZoneOffset(offset) {
         return new this.constructor(this.getTime(), {
@@ -2080,7 +2080,7 @@ export default class DateTime {
      * Returns a copy with the local week changed in the current time zone.
      * @param {number} week The local week.
      * @param {number|null} [day] The local day of the week. (1-7)
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withWeek(week, day = null) {
         if (day === null) {
@@ -2094,7 +2094,7 @@ export default class DateTime {
     /**
      * Returns a copy with the local day of the week changed in the current time zone.
      * @param {number} day The local day of the week. (1-7)
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withWeekDay(day) {
         return setOffsetTime(
@@ -2110,7 +2110,7 @@ export default class DateTime {
     /**
      * Returns a copy with the week day in month changed in the current time zone.
      * @param {number} week The week day in month.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withWeekDayInMonth(week) {
         return this.withDate(
@@ -2125,7 +2125,7 @@ export default class DateTime {
     /**
      * Returns a copy with the week of month changed in the current time zone.
      * @param {number} week The week of month.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withWeekOfMonth(week) {
         return this.withDate(
@@ -2142,7 +2142,7 @@ export default class DateTime {
      * @param {number} year The local week year.
      * @param {number|null} [week] The local week.
      * @param {number|null} [day] The local day of the week. (1-7)
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withWeekYear(year, week = null, day = null) {
         const minDays = minimumDays(this.getLocale());
@@ -2170,7 +2170,7 @@ export default class DateTime {
      * @param {number} year The year.
      * @param {number|null} [month] The month. (1-12)
      * @param {number|null} [date] The date of the month.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     withYear(year, month = null, date = null) {
         if (month === null) {