@fr0st/datetime 7.0.0 → 8.0.1

package/dist/frost-datetime.js

@@ -21,7 +21,7 @@
      * @template T
      * @param {string} key The key for the values.
      * @param {() => T} callback The callback to generate the values.
-     * @return {T} The cached value.
+     * @returns {T} The cached value.
      */
     function getData(key, callback) {
         if (!data.has(key)) {
@@ -33,7 +33,7 @@
     /**
      * Creates a date formatter for a time zone.
      * @param {string} timeZone The time zone.
-     * @return {Intl.DateTimeFormat} The formatter instance.
+     * @returns {Intl.DateTimeFormat} The formatter instance.
      */
     function getDateFormatter(timeZone) {
         return getData(
@@ -55,7 +55,7 @@
     /**
      * Creates a relative-time formatter for a locale.
      * @param {string} locale The locale.
-     * @return {Intl.RelativeTimeFormat|null} The formatter instance, or null when unsupported.
+     * @returns {Intl.RelativeTimeFormat|null} The formatter instance, or null when unsupported.
      */
     function getRelativeFormatter(locale) {
         if (!('RelativeTimeFormat' in Intl)) {
@@ -74,7 +74,7 @@
      * Creates a formatter for a locale.
      * @param {string} locale The locale.
      * @param {Intl.DateTimeFormatOptions} options The options for the formatter.
-     * @return {Intl.DateTimeFormat} The formatter instance.
+     * @returns {Intl.DateTimeFormat} The formatter instance.
      */
     function makeFormatter(locale, options) {
         return new Intl.DateTimeFormat(locale, {
@@ -150,7 +150,7 @@
     /**
      * Escapes a string for safe use inside a RegExp source.
      * @param {string} value The string to escape.
-     * @return {string} The escaped string.
+     * @returns {string} The escaped string.
      */
     function escapeRegExp(value) {
         return value.replace(/[|\\{}()[\]^$+*?.-]/g, '\\$&');
@@ -159,7 +159,7 @@
     /**
      * Gets a stable day number from a DateTime's local calendar fields.
      * @param {DateTime} date The DateTime.
-     * @return {number} The local calendar day number.
+     * @returns {number} The local calendar day number.
      */
     function calendarDay(date) {
         const calendarDate = new Date(0);
@@ -174,7 +174,7 @@
      * @param {DateTime} other The DateTime to compare to.
      * @param {'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second'} timeUnit The time unit to compare in.
      * @param {boolean} [relative=true] Whether to use relative boundaries when calculating the difference.
-     * @return {number} The difference between the dates in the given time unit.
+     * @returns {number} The difference between the dates in the given time unit.
      */
     function calculateDiff(date, other, timeUnit, relative = true) {
         other = other.withTimeZone(date.getTimeZone());
@@ -286,7 +286,7 @@
      * Gets the RegExp for a list of string values.
      * Longer values are matched first to avoid prefix collisions.
      * @param {string[]} values The values to include in the RegExp.
-     * @return {string} The values RegExp.
+     * @returns {string} The values RegExp.
      */
     function valuesRegExp(values) {
         return values.slice()
@@ -301,7 +301,7 @@
      * @param {number} amount The amount to compensate.
      * @param {boolean} [compensate=true] Whether to compensate the amount.
      * @param {number} [compensation=1] The compensation offset.
-     * @return {number} The compensated amount.
+     * @returns {number} The compensated amount.
      */
     function compensateDiff(date, other, amount, compensate = true, compensation = 1) {
         if (amount > 0) {
@@ -324,7 +324,7 @@
      * Gets the biggest difference between two dates.
      * @param {DateTime} date The DateTime.
      * @param {DateTime} [other] The DateTime to compare to.
-     * @return {[number, string]} The biggest difference (amount and time unit).
+     * @returns {[number, string]} The biggest difference (amount and time unit).
      */
     function getBiggestDiff(date, other) {
         let lastResult;
@@ -355,7 +355,7 @@
     /**
      * Gets the offset for a DateTime.
      * @param {DateTime} date The DateTime.
-     * @return {number} The offset.
+     * @returns {number} The offset.
      */
     function getOffset(date) {
         const timeZone = date.getTimeZone();
@@ -394,7 +394,7 @@
     /**
      * Gets the number of milliseconds since the UNIX epoch (offset to timeZone).
      * @param {DateTime} date The DateTime.
-     * @return {number} The number of milliseconds since the UNIX epoch (offset to timeZone).
+     * @returns {number} The number of milliseconds since the UNIX epoch (offset to timeZone).
      */
     function getOffsetTime(date) {
         return date.getTime() - (date.getTimeZoneOffset() * 60000);
@@ -417,7 +417,7 @@
     /**
      * Parses a supported unzoned ISO string as a neutral wall-clock timestamp.
      * @param {string} dateString The date string to parse.
-     * @return {number|null} The timestamp, or null if the shape is not supported.
+     * @returns {number|null} The timestamp, or null if the shape is not supported.
      */
     function parseLocalTimestamp(dateString) {
         const match =
@@ -446,7 +446,7 @@
     }
     /**
      * Generates methods for parsing a date.
-     * @return {Record<string, {get: Function, set: Function}>} An object containing date parsing methods.
+     * @returns {Record<string, {get: Function, set: Function}>} An object containing date parsing methods.
      */
     function parseFactory() {
         let isPM = false;
@@ -552,7 +552,7 @@
      * @param {DateTime} date The DateTime.
      * @param {number} time The number of milliseconds since the UNIX epoch (offset to timeZone).
      * @param {number} [direction=1] The direction to resolve a gap.
-     * @return {DateTime} A new DateTime instance.
+     * @returns {DateTime} A new DateTime instance.
      */
     function setOffsetTime(date, time, direction = 1) {
         const newDate = date.withTime(
@@ -591,8 +591,8 @@
     /**
      * Gets cached localized day-period labels.
      * @param {string} locale The locale.
-     * @param {string} [type=long] The formatting type.
-     * @return {string[]} The localized day-period labels.
+     * @param {string} [type='long'] The formatting type.
+     * @returns {string[]} The localized day-period labels.
      */
     function getDayPeriods(locale, type = 'long') {
         return getData(
@@ -612,9 +612,9 @@
     /**
      * Gets cached localized weekday labels.
      * @param {string} locale The locale.
-     * @param {string} [type=long] The formatting type.
+     * @param {string} [type='long'] The formatting type.
      * @param {boolean} [standalone=true] Whether the values are standalone.
-     * @return {string[]} The localized weekday labels.
+     * @returns {string[]} The localized weekday labels.
      */
     function getDays(locale, type = 'long', standalone = true) {
         return getData(
@@ -643,8 +643,8 @@
     /**
      * Gets cached localized era labels.
      * @param {string} locale The locale.
-     * @param {string} [type=long] The formatting type.
-     * @return {string[]} The localized era labels.
+     * @param {string} [type='long'] The formatting type.
+     * @returns {string[]} The localized era labels.
      */
     function getEras(locale, type = 'long') {
         return getData(
@@ -664,9 +664,9 @@
     /**
      * Gets cached localized month labels.
      * @param {string} locale The locale.
-     * @param {string} [type=long] The formatting type.
+     * @param {string} [type='long'] The formatting type.
      * @param {boolean} [standalone=true] Whether the values are standalone.
-     * @return {string[]} The localized month labels.
+     * @returns {string[]} The localized month labels.
      */
     function getMonths(locale, type = 'long', standalone = true) {
         return getData(
@@ -695,7 +695,7 @@
     /**
      * Gets cached localized digit glyphs.
      * @param {string} locale The locale.
-     * @return {string[]} The localized digit glyphs.
+     * @returns {string[]} The localized digit glyphs.
      */
     function getNumbers(locale) {
         return getData(
@@ -714,7 +714,7 @@
      * Gets the RegExp for the number values.
      * @param {string} locale The locale.
      * @param {number|null} [length=null] The exact number of digits to match.
-     * @return {string} The number values RegExp.
+     * @returns {string} The number values RegExp.
      */
     function numberRegExp(locale, length = null) {
         const quantifier = length === null ?
@@ -727,9 +727,9 @@
      * Formats a day as a locale string.
      * @param {string} locale The locale.
      * @param {number} day The day to format (0-6).
-     * @param {string} [type=long] The formatting type.
+     * @param {string} [type='long'] The formatting type.
      * @param {boolean} [standalone=true] Whether the value is standalone.
-     * @return {string} The formatted string.
+     * @returns {string} The formatted string.
      */
     function formatDay(locale, day, type = 'long', standalone = true) {
         return getDays(locale, type, standalone)[day];
@@ -738,8 +738,8 @@
      * Formats a day period as a locale string.
      * @param {string} locale The locale.
      * @param {number} period The day-period index to format. (0-1)
-     * @param {string} [type=long] The formatting type.
-     * @return {string} The formatted string.
+     * @param {string} [type='long'] The formatting type.
+     * @returns {string} The formatted string.
      */
     function formatDayPeriod(locale, period, type = 'long') {
         return getDayPeriods(locale, type)[period];
@@ -748,8 +748,8 @@
      * Formats an era as a locale string.
      * @param {string} locale The locale.
      * @param {number} era The era index to format. (0-1)
-     * @param {string} [type=long] The formatting type.
-     * @return {string} The formatted string.
+     * @param {string} [type='long'] The formatting type.
+     * @returns {string} The formatted string.
      */
     function formatEra(locale, era, type = 'long') {
         return getEras(locale, type)[era];
@@ -758,9 +758,9 @@
      * Formats a month as a locale string.
      * @param {string} locale The locale.
      * @param {number} month The month to format (1-12).
-     * @param {string} [type=long] The formatting type.
+     * @param {string} [type='long'] The formatting type.
      * @param {boolean} [standalone=true] Whether the value is standalone.
-     * @return {string} The formatted string.
+     * @returns {string} The formatted string.
      */
     function formatMonth(locale, month, type = 'long', standalone = true) {
         return getMonths(locale, type, standalone)[month - 1];
@@ -770,7 +770,7 @@
      * @param {string} locale The locale.
      * @param {number} number The number to format.
      * @param {number} [padding=0] The amount of padding to use.
-     * @return {string} The formatted string.
+     * @returns {string} The formatted string.
      */
     function formatNumber(locale, number, padding = 0) {
         const numbers = getNumbers(locale);
@@ -784,7 +784,7 @@
      * @param {boolean} [useColon=true] Whether to use a colon separator.
      * @param {boolean} [optionalMinutes=false] Whether minutes are optional.
      * @param {boolean} [includeSeconds=true] Whether seconds are included.
-     * @return {string} The formatted offset string.
+     * @returns {string} The formatted offset string.
      */
     function formatOffset(offset, useColon = true, optionalMinutes = false, includeSeconds = true) {
         const absoluteSeconds = Math.abs(offset * 60);
@@ -818,7 +818,7 @@
      * @param {string} locale The locale.
      * @param {number} amount The amount of duration.
      * @param {string} unit The time unit.
-     * @return {string} The relative duration.
+     * @returns {string} The relative duration.
      */
     function formatRelative(locale, amount, unit) {
         const relativeFormatter = getRelativeFormatter(locale);
@@ -834,8 +834,8 @@
      * @param {string} locale The locale.
      * @param {number} timestamp The timestamp to use.
      * @param {string} timeZone The time zone to format.
-     * @param {string} [type=long] The formatting type.
-     * @return {string} The formatted string.
+     * @param {string} [type='long'] The formatting type.
+     * @returns {string} The formatted string.
      */
     function formatTimeZoneName(locale, timestamp, timeZone, type = 'long') {
         return makeFormatter(locale, { second: 'numeric', timeZone, timeZoneName: type })
@@ -852,7 +852,7 @@
      * @param {object} data The generated locale data.
      * @param {string[]} candidates The locale candidates.
      * @param {number} fallback The fallback value.
-     * @return {number} The locale value.
+     * @returns {number} The locale value.
      */
     function generatedValue(data, candidates, fallback) {
         for (const candidate of candidates) {
@@ -869,7 +869,7 @@
     /**
      * Gets generated-data candidates for a locale.
      * @param {Intl.Locale} locale The locale.
-     * @return {string[]} The locale candidates.
+     * @returns {string[]} The locale candidates.
      */
     function localeCandidates(locale) {
         const localeName = locale.toString().split('-x-', 1)[0];
@@ -894,7 +894,7 @@
     /**
      * Gets week information for a locale.
      * @param {string} locale The locale.
-     * @return {{firstDay: number, minimalDays: number}} The week information.
+     * @returns {{firstDay: number, minimalDays: number}} The week information.
      */
     function getWeekInfo(locale) {
         return getData(
@@ -928,7 +928,7 @@
     /**
      * Decodes a quoted ICU format literal.
      * @param {string} literal The literal to decode.
-     * @return {string} The decoded literal.
+     * @returns {string} The decoded literal.
      */
     function decodeLiteral(literal) {
         return literal === `''` ?
@@ -938,7 +938,7 @@
     /**
      * Gets the formatting type from the component token length.
      * @param {number} length The component token length.
-     * @return {string} The formatting type.
+     * @returns {string} The formatting type.
      */
     function getType(length) {
         switch (length) {
@@ -957,7 +957,7 @@
      * @param {number} length The token length.
      * @param {string} locale The parsing locale.
      * @param {boolean} previousNumeric Whether the previous token was an adjacent numeric token.
-     * @return {{numeric: boolean, source: string}} The token RegExp data.
+     * @returns {{numeric: boolean, source: string}} The token RegExp data.
      */
     function getTokenRegExp(source, nextSource, length, locale, previousNumeric) {
         const numberSource = numberRegExp(locale);
@@ -974,7 +974,7 @@
     /**
      * Gets the locale's minimum days in the first week of the year.
      * @param {string} locale The locale.
-     * @return {number} The minimum day count.
+     * @returns {number} The minimum day count.
      */
     function minimumDays(locale) {
         return getWeekInfo(locale).minimalDays;
@@ -983,7 +983,7 @@
      * Converts a Sunday-based day-of-week value to the locale's week numbering.
      * @param {string} locale The locale.
      * @param {number} day The day of the week. (0 = Sunday, 6 = Saturday)
-     * @return {number} The local day of the week.
+     * @returns {number} The local day of the week.
      */
     function weekDay(locale, day) {
         return (7 + parseInt(day, 10) - (getWeekInfo(locale).firstDay % 7)) % 7 + 1;
@@ -993,9 +993,9 @@
      * Parses a day from a locale string.
      * @param {string} locale The locale.
      * @param {string} value The value to parse.
-     * @param {string} [type=long] The formatting type.
+     * @param {string} [type='long'] The formatting type.
      * @param {boolean} [standalone=true] Whether the value is standalone.
-     * @return {number} The local day of the week (1-7).
+     * @returns {number} The local day of the week (1-7).
      */
     function parseDay(locale, value, type = 'long', standalone = true) {
         const day = getDays(locale, type, standalone).indexOf(value);
@@ -1008,8 +1008,8 @@
      * Parses a day period from a locale string.
      * @param {string} locale The locale.
      * @param {string} value The value to parse.
-     * @param {string} [type=long] The formatting type.
-     * @return {number} The day period (0-1).
+     * @param {string} [type='long'] The formatting type.
+     * @returns {number} The day period (0-1).
      */
     function parseDayPeriod(locale, value, type = 'long') {
         return getDayPeriods(locale, type).indexOf(value);
@@ -1018,8 +1018,8 @@
      * Parses an era from a locale string.
      * @param {string} locale The locale.
      * @param {string} value The value to parse.
-     * @param {string} [type=long] The formatting type.
-     * @return {number} The era (0-1).
+     * @param {string} [type='long'] The formatting type.
+     * @returns {number} The era (0-1).
      */
     function parseEra(locale, value, type = 'long') {
         return getEras(locale, type).indexOf(value);
@@ -1028,9 +1028,9 @@
      * Parses a month from a locale string.
      * @param {string} locale The locale.
      * @param {string} value The value to parse.
-     * @param {string} [type=long] The formatting type.
+     * @param {string} [type='long'] The formatting type.
      * @param {boolean} [standalone=true] Whether the value is standalone.
-     * @return {number} The month number (1-12).
+     * @returns {number} The month number (1-12).
      */
     function parseMonth(locale, value, type = 'long', standalone = true) {
         return getMonths(locale, type, standalone).indexOf(value) + 1;
@@ -1039,7 +1039,7 @@
      * Parses locale digits into an ASCII digit string.
      * @param {string} locale The locale.
      * @param {string} value The value to parse.
-     * @return {string} The parsed ASCII digit string.
+     * @returns {string} The parsed ASCII digit string.
      */
     function parseNumberString(locale, value) {
         const numbers = getNumbers(locale);
@@ -1049,7 +1049,7 @@
      * Parses a number from a locale number string.
      * @param {string} locale The locale.
      * @param {string} value The value to parse.
-     * @return {number} The parsed number.
+     * @returns {number} The parsed number.
      */
     function parseNumber(locale, value) {
         return parseInt(
@@ -1723,7 +1723,7 @@
          * @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)
@@ -1739,7 +1739,7 @@
          * 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);
@@ -1759,7 +1759,7 @@
         /**
          * 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) ?
@@ -1774,7 +1774,7 @@
          * @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);
@@ -1800,7 +1800,7 @@
          * @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);
@@ -1813,9 +1813,9 @@
          * @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 ?
@@ -1963,7 +1963,7 @@
          * @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, {
@@ -1987,7 +1987,7 @@
          * @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)
@@ -1996,7 +1996,7 @@
 
         /**
          * Gets the default locale.
-         * @return {string} The locale.
+         * @returns {string} The locale.
          */
         static getDefaultLocale() {
             return config.defaultLocale;
@@ -2004,7 +2004,7 @@
 
         /**
          * Gets the default time zone.
-         * @return {string} The default time zone.
+         * @returns {string} The default time zone.
          */
         static getDefaultTimeZone() {
             return config.defaultTimeZone;
@@ -2013,7 +2013,7 @@
         /**
          * 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);
@@ -2027,7 +2027,7 @@
          * @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);
@@ -2146,7 +2146,7 @@
 
         /**
          * Adds a day to the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         addDay() {
             return this.addDays(1);
@@ -2155,7 +2155,7 @@
         /**
          * 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(
@@ -2169,7 +2169,7 @@
 
         /**
          * Adds an hour to the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         addHour() {
             return this.addHours(1);
@@ -2178,7 +2178,7 @@
         /**
          * 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(
@@ -2188,7 +2188,7 @@
 
         /**
          * Adds a minute to the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         addMinute() {
             return this.addMinutes(1);
@@ -2197,7 +2197,7 @@
         /**
          * 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(
@@ -2207,7 +2207,7 @@
 
         /**
          * Adds a month to the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         addMonth() {
             return this.addMonths(1);
@@ -2216,7 +2216,7 @@
         /**
          * 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(
@@ -2226,7 +2226,7 @@
 
         /**
          * Adds a second to the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         addSecond() {
             return this.addSeconds(1);
@@ -2235,7 +2235,7 @@
         /**
          * 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(
@@ -2245,7 +2245,7 @@
 
         /**
          * Adds a week to the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         addWeek() {
             return this.addWeeks(1);
@@ -2254,7 +2254,7 @@
         /**
          * 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(
@@ -2264,7 +2264,7 @@
 
         /**
          * Adds a year to the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         addYear() {
             return this.addYears(1);
@@ -2273,7 +2273,7 @@
         /**
          * 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(
@@ -2284,7 +2284,7 @@
         /**
          * 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);
@@ -2293,7 +2293,7 @@
         /**
          * 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(
@@ -2307,7 +2307,7 @@
 
         /**
          * 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(
@@ -2318,7 +2318,7 @@
 
         /**
          * 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(
@@ -2329,7 +2329,7 @@
         /**
          * 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;
@@ -2339,7 +2339,7 @@
          * 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);
@@ -2349,7 +2349,7 @@
          * 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);
@@ -2359,7 +2359,7 @@
          * 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);
@@ -2369,7 +2369,7 @@
          * 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);
@@ -2379,7 +2379,7 @@
          * 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);
@@ -2389,7 +2389,7 @@
          * 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);
@@ -2399,7 +2399,7 @@
          * 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);
@@ -2407,7 +2407,7 @@
 
         /**
          * 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);
@@ -2415,7 +2415,7 @@
 
         /**
          * 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);
@@ -2423,7 +2423,7 @@
 
         /**
          * 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);
@@ -2431,7 +2431,7 @@
 
         /**
          * 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())
@@ -2440,7 +2440,7 @@
 
         /**
          * 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;
@@ -2450,7 +2450,7 @@
 
         /**
          * 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);
@@ -2458,7 +2458,7 @@
 
         /**
          * 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)
@@ -2467,7 +2467,7 @@
 
         /**
          * 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)
@@ -2477,7 +2477,7 @@
         /**
          * 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(
@@ -2492,7 +2492,7 @@
         /**
          * 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;
@@ -2532,7 +2532,7 @@
 
         /**
          * 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();
@@ -2540,7 +2540,7 @@
 
         /**
          * 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();
@@ -2548,7 +2548,7 @@
 
         /**
          * 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(
@@ -2560,7 +2560,7 @@
 
         /**
          * 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();
@@ -2568,7 +2568,7 @@
 
         /**
          * Gets the current locale.
-         * @return {string} The locale.
+         * @returns {string} The locale.
          */
         getLocale() {
             return this._locale;
@@ -2576,7 +2576,7 @@
 
         /**
          * Gets the milliseconds in the current time zone.
-         * @return {number} The milliseconds.
+         * @returns {number} The milliseconds.
          */
         getMilliseconds() {
             return new Date(getOffsetTime(this)).getUTCMilliseconds();
@@ -2584,7 +2584,7 @@
 
         /**
          * 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();
@@ -2592,7 +2592,7 @@
 
         /**
          * 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;
@@ -2600,7 +2600,7 @@
 
         /**
          * 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);
@@ -2608,7 +2608,7 @@
 
         /**
          * 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();
@@ -2616,7 +2616,7 @@
 
         /**
          * 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();
@@ -2624,7 +2624,7 @@
 
         /**
          * 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);
@@ -2632,7 +2632,7 @@
 
         /**
          * Gets the current time zone.
-         * @return {string} The time zone.
+         * @returns {string} The time zone.
          */
         getTimeZone() {
             return this._timeZone;
@@ -2640,7 +2640,7 @@
 
         /**
          * 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;
@@ -2648,7 +2648,7 @@
 
         /**
          * 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);
@@ -2662,7 +2662,7 @@
 
         /**
          * 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(
@@ -2673,7 +2673,7 @@
 
         /**
          * 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();
@@ -2688,7 +2688,7 @@
 
         /**
          * 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();
@@ -2700,7 +2700,7 @@
 
         /**
          * 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());
@@ -2709,7 +2709,7 @@
 
         /**
          * Gets the year in the current time zone.
-         * @return {number} The year.
+         * @returns {number} The year.
          */
         getYear() {
             return new Date(getOffsetTime(this)).getUTCFullYear();
@@ -2718,7 +2718,7 @@
         /**
          * 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);
@@ -2728,7 +2728,7 @@
         /**
          * 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');
@@ -2737,7 +2737,7 @@
         /**
          * 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');
@@ -2746,7 +2746,7 @@
         /**
          * 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');
@@ -2755,7 +2755,7 @@
         /**
          * 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');
@@ -2764,7 +2764,7 @@
         /**
          * 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');
@@ -2773,7 +2773,7 @@
         /**
          * 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');
@@ -2782,7 +2782,7 @@
         /**
          * 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');
@@ -2791,7 +2791,7 @@
         /**
          * 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;
@@ -2800,7 +2800,7 @@
         /**
          * 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;
@@ -2809,7 +2809,7 @@
         /**
          * 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;
@@ -2818,7 +2818,7 @@
         /**
          * 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;
@@ -2827,7 +2827,7 @@
         /**
          * 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;
@@ -2836,7 +2836,7 @@
         /**
          * 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;
@@ -2845,7 +2845,7 @@
         /**
          * 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;
@@ -2854,7 +2854,7 @@
         /**
          * 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;
@@ -2863,7 +2863,7 @@
         /**
          * 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;
@@ -2872,7 +2872,7 @@
         /**
          * 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;
@@ -2881,7 +2881,7 @@
         /**
          * 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;
@@ -2890,7 +2890,7 @@
         /**
          * 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;
@@ -2899,7 +2899,7 @@
         /**
          * 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;
@@ -2908,7 +2908,7 @@
         /**
          * 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;
@@ -2917,7 +2917,7 @@
         /**
          * 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;
@@ -2926,7 +2926,7 @@
         /**
          * 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;
@@ -2936,7 +2936,7 @@
          * 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);
@@ -2946,7 +2946,7 @@
          * 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);
@@ -2956,7 +2956,7 @@
          * 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);
@@ -2966,7 +2966,7 @@
          * 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);
@@ -2976,7 +2976,7 @@
          * 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);
@@ -2986,7 +2986,7 @@
          * 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);
@@ -2996,7 +2996,7 @@
          * 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);
@@ -3006,7 +3006,7 @@
          * 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);
@@ -3014,7 +3014,7 @@
 
         /**
          * 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) {
@@ -3034,7 +3034,7 @@
 
         /**
          * 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(
@@ -3045,7 +3045,7 @@
         /**
          * 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;
@@ -3054,7 +3054,7 @@
         /**
          * 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;
@@ -3063,7 +3063,7 @@
         /**
          * 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;
@@ -3072,7 +3072,7 @@
         /**
          * 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;
@@ -3081,7 +3081,7 @@
         /**
          * 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;
@@ -3090,7 +3090,7 @@
         /**
          * 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;
@@ -3099,7 +3099,7 @@
         /**
          * 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;
@@ -3108,7 +3108,7 @@
         /**
          * 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;
@@ -3117,7 +3117,7 @@
         /**
          * 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;
@@ -3126,7 +3126,7 @@
         /**
          * 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;
@@ -3135,7 +3135,7 @@
         /**
          * 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;
@@ -3144,7 +3144,7 @@
         /**
          * 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;
@@ -3153,7 +3153,7 @@
         /**
          * 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;
@@ -3162,7 +3162,7 @@
         /**
          * 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;
@@ -3171,7 +3171,7 @@
         /**
          * 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;
@@ -3180,7 +3180,7 @@
         /**
          * 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;
@@ -3189,7 +3189,7 @@
         /**
          * 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;
@@ -3198,7 +3198,7 @@
         /**
          * 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;
@@ -3207,7 +3207,7 @@
         /**
          * 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;
@@ -3216,7 +3216,7 @@
         /**
          * 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;
@@ -3225,7 +3225,7 @@
         /**
          * 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;
@@ -3234,7 +3234,7 @@
         /**
          * 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;
@@ -3243,7 +3243,7 @@
         /**
          * 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;
@@ -3252,7 +3252,7 @@
         /**
          * 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;
@@ -3261,7 +3261,7 @@
         /**
          * 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);
@@ -3269,7 +3269,7 @@
 
         /**
          * 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);
@@ -3277,7 +3277,7 @@
 
         /**
          * 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);
@@ -3285,7 +3285,7 @@
 
         /**
          * 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);
@@ -3293,7 +3293,7 @@
 
         /**
          * 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)
@@ -3302,7 +3302,7 @@
 
         /**
          * 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;
@@ -3312,7 +3312,7 @@
 
         /**
          * 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);
@@ -3320,7 +3320,7 @@
 
         /**
          * 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)
@@ -3329,7 +3329,7 @@
 
         /**
          * 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)
@@ -3338,7 +3338,7 @@
 
         /**
          * Subtracts a day from the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         subDay() {
             return this.addDays(-1);
@@ -3347,7 +3347,7 @@
         /**
          * 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);
@@ -3355,7 +3355,7 @@
 
         /**
          * Subtracts an hour from the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         subHour() {
             return this.addHours(-1);
@@ -3364,7 +3364,7 @@
         /**
          * 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);
@@ -3372,7 +3372,7 @@
 
         /**
          * Subtracts a minute from the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         subMinute() {
             return this.addMinutes(-1);
@@ -3381,7 +3381,7 @@
         /**
          * 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);
@@ -3389,7 +3389,7 @@
 
         /**
          * Subtracts a month from the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         subMonth() {
             return this.addMonths(-1);
@@ -3398,7 +3398,7 @@
         /**
          * 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);
@@ -3406,7 +3406,7 @@
 
         /**
          * Subtracts a second from the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         subSecond() {
             return this.addSeconds(-1);
@@ -3415,7 +3415,7 @@
         /**
          * 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);
@@ -3423,7 +3423,7 @@
 
         /**
          * Subtracts a week from the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         subWeek() {
             return this.addWeeks(-1);
@@ -3432,7 +3432,7 @@
         /**
          * 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);
@@ -3440,7 +3440,7 @@
 
         /**
          * Subtracts a year from the current DateTime.
-         * @return {DateTime} A new DateTime instance.
+         * @returns {DateTime} A new DateTime instance.
          */
         subYear() {
             return this.addYears(-1);
@@ -3449,7 +3449,7 @@
         /**
          * 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);
@@ -3458,7 +3458,7 @@
         /**
          * 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' ?
@@ -3469,7 +3469,7 @@
         /**
          * 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 ?
@@ -3479,7 +3479,7 @@
 
         /**
          * 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);
@@ -3487,9 +3487,9 @@
 
         /**
          * 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')
@@ -3498,17 +3498,17 @@
 
         /**
          * 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);
@@ -3516,7 +3516,7 @@
 
         /**
          * 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);
@@ -3524,7 +3524,7 @@
 
         /**
          * 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
@@ -3535,7 +3535,7 @@
 
         /**
          * 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();
@@ -3543,7 +3543,7 @@
 
         /**
          * 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());
@@ -3553,7 +3553,7 @@
         /**
          * 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(
@@ -3565,7 +3565,7 @@
         /**
          * 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(
@@ -3581,7 +3581,7 @@
         /**
          * 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(
@@ -3599,7 +3599,7 @@
          * @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(
@@ -3611,7 +3611,7 @@
         /**
          * 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(), {
@@ -3623,7 +3623,7 @@
         /**
          * 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(
@@ -3637,7 +3637,7 @@
          * @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(
@@ -3650,7 +3650,7 @@
          * 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) {
@@ -3679,7 +3679,7 @@
         /**
          * 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(
@@ -3695,7 +3695,7 @@
          * 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(
@@ -3707,7 +3707,7 @@
         /**
          * 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, {
@@ -3719,7 +3719,7 @@
         /**
          * 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);
@@ -3728,7 +3728,7 @@
         /**
          * 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(), {
@@ -3740,7 +3740,7 @@
         /**
          * 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(), {
@@ -3753,7 +3753,7 @@
          * 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) {
@@ -3767,7 +3767,7 @@
         /**
          * 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(
@@ -3783,7 +3783,7 @@
         /**
          * 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(
@@ -3798,7 +3798,7 @@
         /**
          * 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(
@@ -3815,7 +3815,7 @@
          * @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());
@@ -3843,7 +3843,7 @@
          * @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) {