Skip to content

fix(deps): update dependency date-fns to v3

Soos requested to merge renovate/date-fns-3.x into main

This MR contains the following updates:

Package Type Update Change
date-fns dependencies major ^1.30.1 -> ^3.0.0

Release Notes

date-fns/date-fns (date-fns)

v3.3.1

Compare Source

Kudos to @​kossnocorp and @​fturmel for working on the release.

Fixed

  • Fixed DST issue in getOverlappingDaysInIntervals, resulting in an inconsistent number of days returned for intervals starting and ending in different DST periods.

  • Fixed functions incorrectly using trunc instead of round. The bug was introduced in v3.3.0. The affected functions: differenceInCalendarDays, differenceInCalendarISOWeeks, differenceInCalendarWeeks, getISOWeek, getWeek, and getISOWeeksInYear.

v3.3.0

Compare Source

On this release worked @​kossnocorp, @​TheKvikk, @​fturmel and @​ckcherry23.

Fixed

  • Fixed the bug in getOverlappingDaysInIntervals caused by incorrect sorting of interval components that led to 0 for timestamps of different lengths.

  • Fixed bugs when working with negative numbers caused by using Math.floor (-1.1 → -2) instead of Math.trunc (-1.1 → -1). Most of the conversion functions (i.e., hoursToMinutes) were affected when passing some negative fractional input. Also, some other functions that could be possibly affected by unfortunate timezone/date combinations were fixed.

    The functions that were affected: format, parse, getUnixTime, daysToWeeks, hoursToMilliseconds, hoursToMinutes, hoursToSeconds, milliseconds, minutesToMilliseconds, millisecondsToMinutes, monthsToYears, millisecondsToHours, millisecondsToSeconds, minutesToHours, minutesToSeconds, yearsToQuarters, yearsToMonths, yearsToDays, weeksToDays, secondsToMinutes, secondsToHours, quartersToYears, quartersToMonths and monthsToQuarters.

  • Fixed the Czech locale's formatDistance to include 1 in formatDistance.

  • Fixed differenceInSeconds and other functions relying on rounding options that can produce a negative 0.

  • Added a preprocessor to the locales API, enabling fixing a long-standing bug in the French locale. (#​1391)

  • Added missing yearsToDays to the FP submodule.

  • Made functions using rounding methods always return 0 instead of -0.

Added

v3.2.0

Compare Source

This release is brought to you by @​kossnocorp, @​fturmel, @​grossbart, @​MelvinVermeer, and @​jcarstairs-scottlogic.

Fixed
Added
  • Added exports of format, lightFormat, and parse internals that enable 3rd-parties to consume those.

v3.1.0

Compare Source

This release is brought to you by @​kossnocorp, @​makstyle119 and @​dmgawel.

Fixed
Added

v3.0.6

Compare Source

On this release worked @​imwh0im, @​jamcry and @​tyrw.

Fixed

v3.0.5

Compare Source

This release is brought to you by @​goku4199.

Fixed

v3.0.4

Compare Source

This release is brought to you by @​kossnocorp.

Fixed
  • Fixed isWithinInterval bug caused by incorrectly sorting dates (#​3623).

v3.0.3

Compare Source

Fixed
  • Rolled back pointing ESM types to the same d.ts files. Instead now it copies the content to avoid the Masquerading as CJS problem reported by "Are the types wrong?".

v3.0.2

Compare Source

Fixed

v3.0.1

Compare Source

Fixed
  • Fixed an error in certain environments caused by d.mts files exporting only types.

v3.0.0

Compare Source

Changed

  • BREAKING: date-fns is now a dual-package with the support of both ESM and CommonJS. The files exports are now explicitly in the package.json. The ESM files now have .mjs extension.

  • BREAKING: The package now has a flat structure, meaning functions are now named node_modules/date-fns/add.mjs, locales are node_modules/date-fns/locale/enUS.mjs, etc.

  • BREAKING: Now all file content’s exported via named exports instead of export default, which will require change direct imports i.e. const addDays = require(‘date-fns/addDays’) to const { addDays } = require(‘date-fns/addDays’).

  • BREAKING: TypeScript types are now completely rewritten, check out the d.ts files for more information.

  • BREAKING: constants now is not exported via the index, so to import one use import { daysInYear } from "date-fns/constants";. It improves compatibility with setups that modularize imports like Next.js.

  • BREAKING: Functions now don’t check the number of passed arguments, delegating this task to type checkers. The functions are now slimmer because of this.

  • BREAKING The arguments are not explicitly converted to the target types. Instead, they are passed as is, delegating this task to type checkers.

  • BREAKING: Functions that accept Interval arguments now do not throw an error if the start is before the end and handle it as a negative interval. If one of the properties in an Invalid Date, these functions also do not throw and handle them as invalid intervals.

    • areIntervalsOverlapping normalize intervals before comparison, so { start: a, end: b } is practically equivalent to { start: b, end: a }. When comparing intervals with one of the properties being Invalid Date, the function will return false unless the others are valid and equal, given the inclusive option is passed. Otherwise, and when even one of the intervals has both properties invalid, the function will always return false.

    • getOverlappingDaysInIntervals now normalizes intervals before comparison, so { start: a, end: b } is practically equivalent to { start: b, end: a }. If any of the intervals’ properties is an Invalid Date, the function will always return 0.

    • isWithinInterval now normalizes intervals before comparison, so { start: a, end: b } is practically equivalent to { start: b, end: a }. If any of the intervals’ properties is an Invalid Date, the function will always return false.

    • intervalToDuration now returns negative durations for negative intervals. If one or both of the interval properties are invalid, the function will return an empty object.

    • The eachXOfInterval functions (eachDayOfInterval, eachHourOfInterval, eachMinuteOfInterval, eachMonthOfInterval, eachWeekendOfInterval, eachWeekendOfMonth, eachWeekendOfYear, eachWeekOfInterval, eachYearOfInterval) now return a reversed array if the passed interval’s start is after the end. Invalid properties will result in an empty array. Functions that accept the step option now also allow negative, 0, and NaN values and return reversed results if the step is negative and an empty array otherwise.

  • BREAKING: intervalToDuration now skips 0 values in the resulting duration, resulting in more compact objects with only relevant properties.

  • BREAKING: roundToNearestMinutes now returns Invalid Date instead of throwing an error when nearestTo option is less than 1 or more than 30.

  • BREAKING: IE is no longer supported.

  • BREAKING: Now all functions use Math.trunc rounding method where rounding is required. The behavior is configurable on a per-function basis.

  • BREAKING: Undocumented onlyNumeric option was removed from nn and sv locales. If you relied on it, please contact me.

  • BREAKING: Flow is not supported anymore. If you relied on it, please contact me.

  • BREAKING: The locales now use regular functions instead of the UTC version, which should not break any code unless you used locales directly.

Added

  • All functions that accept date arguments now also accept strings.

  • All functions now export options interfaces.

  • Now functions allow passing custom Date extensions like UTCDate. They will detect and use the arguments constructor to generate the result of the same class.

  • eachMonthOfInterval, eachQuarterOfInterval, eachWeekOfInterval, and eachYearOfInterval now accept the step option like most of the eachXOfInterval functions.

  • A new interval function that validates interval, emulating the v2 interval functions behavior.

  • differenceInX functions now accept options and allow setting up roundingMethod that configures how the result is rounded. Math.trunc is the default method.

v2.30.0

Compare Source

Kudos to @​kossnocorp and @​Andarist for working on the release.

Changes
  • Fixed increased build size after enabling compatibility with older browsers in the previous release. This was done by adding @​babel/runtime as a dependency. See more details.

v2.29.3

Compare Source

This release is prepared by our own @​leshakoss.

Fixed

v2.29.2

Compare Source

This release is brought to you by @​nopears, @​vadimpopa and @​leshakoss.

Fixed

v2.29.1

Compare Source

Thanks to @​fturmel for working on the release.

Fixed

v2.29.0

Compare Source

On this release worked @​tan75, @​kossnocorp, @​nopears, @​Balastrong, @​cpapazoglou, @​dovca, @​aliasgar55, @​tomchentw, @​JuanM04, @​alexandresaura, @​fturmel, @​aezell, @​andersravn, @​TiagoPortfolio, @​SukkaW, @​Zebreus, @​aviskarkc10, @​maic66, @​a-korzun, @​Mejans, @​davidspiess, @​alexgul1, @​matroskin062, @​undecaf, @​mprovenc, @​jooola and @​leshakoss.

Added
Fixed
Changed

v2.28.0

Compare Source

Kudos to @​tan75, @​fturmel, @​arcanar7, @​jeffjose, @​helmut-lang, @​zrev2220, @​jooola, @​minitesh, @​cowboy-bebug, @​mesqueeb, @​JuanM04, @​zhirzh, @​damon02 and @​leshakoss for working on the release.

Added
Fixed

v2.27.0

Compare Source

Kudos to @​tan75, @​hg-pyun, @​07akioni, @​razvanmitre, @​Haqverdi, @​pgcalixto, @​janziemba, @​fturmel, @​JuanM04, @​zhirzh, @​seanghay, @​bulutfatih, @​nodeadtree, @​cHaLkdusT, @​a-korzun, @​fishmandev, @​wingclover, @​Zacharias3690, @​kossnocorp and @​leshakoss for working on the release.

Fixed
Added

v2.26.0

Compare Source

Thanks to @​kossnocorp, @​leshakoss, @​tan75, @​gaplo, @​AbdAllahAbdElFattah13, @​fturmel, @​kentaro84207, @​V-Gutierrez, @​atefBB, @​jhonatanmacazana, @​zhirzh, @​Haqverdi, @​mandaputtra, @​micnic and @​rikkalo for working on the release.

Fixed
Changed
Added

v2.25.0

Compare Source

This release is brought to you by @​kossnocorp, @​gierschv, @​fturmel, @​redbmk, @​mprovenc, @​artyom-ivanov and @​tan75.

Added

v2.24.0

Compare Source

Kudos to Sasha Koss, Lucas Silva, Jan Ziemba, Anastasia Kobzar, Deepak Gupta, Jonas L, Kentaro Suzuki, Koussay Haj Kacem, fturmel, Tan75 and Adriaan Callaerts for working on the release.

Fixed
Changed
Added

v2.23.0

Compare Source

Thanks to Liam Tait, fturmel, Takuya Uehara, Branislav Lazic, Seyyed Morteza Moosavi, Felipe Armoni, Sasha Koss, Michael Mok, Tan75 and Maxim Topciu for working on the release.

Changed
Added

v2.22.1

Compare Source

Thanks to Sasha Koss for working on the release.

Fixed

v2.22.0

Compare Source

Sasha Koss, Lucas Silva, Lay, jwbth, fturmel, Tan75 and Anastasia Kobzar worked on this release.

Fixed
Added
  • Added 18 new conversion functions:
    • daysToWeeks
    • hoursToMilliseconds
    • hoursToMinutes
    • hoursToSeconds
    • millisecondsToHours
    • millisecondsToMinutes
    • millisecondsToSeconds
    • minutesToHours
    • minutesToMilliseconds
    • minutesToSeconds
    • monthsToQuarters
    • monthsToYears
    • quartersToMonths
    • quartersToYears
    • secondsToHours
    • secondsToMilliseconds
    • secondsToMinutes
    • weeksToDays
    • yearsToMonths
    • yearsToQuarters

v2.21.3

Compare Source

This release is brought to you by Maxim Topciu.

Fixed

v2.21.2

Compare Source

Kudos to Aleksei Korzun, Maxim Topciu, Jonas L, Mohammad ali Ali panah and Tan75 for working on the release.

Fixed

v2.21.1

Compare Source

Thanks to Sasha Koss for working on the release.

Fixed

v2.21.0

Compare Source

This release is brought to you by Aleksei Korzun, Tan75, Rubens Mariuzzo, Christoph Stenglein and Clément Tamisier.

Fixed
Added

v2.20.3

Compare Source

Kudos to fturmel for working on the release.

Fixed

v2.20.2

Compare Source

Kudos to Maxim Topciu for working on the release.

Fixed

v2.20.1

Compare Source

This release is brought to you by Sasha Koss and Tan75.

Fixed
  • Fixed isDate Flow typings that we broke in v2.20.0.

v2.20.0

Compare Source

This release is brought to you by Sasha Koss, Maxim Topciu, tu4mo, Tan75, Ardit Dine, Carl Rosell, Roman Mahotskyi, Mateusz Krzak, fgottschalk, Anastasia Kobzar, Bilguun Ochirbat, Lesha Koss, YuLe and guyroberts21.

Fixed
Added

v2.19.0

Compare Source

Tan75 worked on this release.

Fixed
Added

v2.18.0

Compare Source

Thanks to Tan75 and Lesha Koss.

Fixed
Added

v2.17.0

Compare Source

Kudos to @​shaykav, @​davidgape89, @​rikkalo, @​tan75, @​talgautb, @​owenl131, @​kylesezhi, @​inigoiparragirre, @​gius, @​Endeauvirr and @​frankyston.

Fixed
Added

v2.16.1

Compare Source

Kudos to @​aleksaps, @​leedriscoll and @​BanForFun for pull-requests!

Fixed

v2.16.0

Compare Source

Kudos to @​jvpelt, @​piotrl, @​yotamofek, @​dwaxweiler, @​leedriscoll and @​bradevans for working on the release. Also thanks to @​PascalHonegger, @​pickfire, @​TheJaredWilcurt, @​SidKH and @​nfantone for improving the documentation.

Fixed
Changed
Added

v2.15.0

Compare Source

Thanks to @​belgamo, @​Matsuuu, @​Imballinst, @​arsnyder16, @​pankajupadhyay29, @​DCBN, @​leedriscoll, @​gottsohn, @​mukuljainx and @​dtriana for working on the release. Also kudos to @​KidkArolis, @​imgx64, @​fjc0k, @​wmonk, @​djD-REK, @​dandv, @​psimk and @​brimworks for improving the documentation.

Fixed
Changed
Added

v2.14.0

Compare Source

Kudos to @​julamb, @​JacobSoderblom, @​justingrant, @​dragunoff, @​jmate0321, @​gbhasha, @​rasck, @​AlbertoPdRF, @​sebastianhaberey and @​giogonzo for working on the release!

Fixed
Added

v2.13.0

Compare Source

Thanks to @​JorenVos, @​developergouli, @​rhlowe and @​justingrant for working on the release!

Fixed
Added

v2.12.0

Compare Source

Kudos to @​leshakoss, @​skyuplam, @​so99ynoodles, @​dkozickis, @​belgamo, @​akgondber, @​dcousens and @​BoomDev for working on the release!

Fixed
Added

v2.11.1

Compare Source

Fixed
  • Rebuilt TypeScript and flow types.

v2.11.0

Compare Source

Kudos to @​oakhan3, @​Mukhammadali, @​altrim, @​leepowellcouk, @​amatzon, @​bryanMt, @​kalekseev, @​eugene-platov and @​tjrobinson for working on the release.

Fixed
Changed
Added

v2.10.0

Compare Source

Fixed
Fixed
  • Fixed a bug in setDay when using weekStartsOn that is not 0
Added

v2.9.0

Compare Source

Thanks to @​mborgbrant, @​saintplay, @​mrenty, @​kibertoad, @​levibuzolic, @​Anshuman71, @​talgautb, @​filipjuza, @​tobyzerner, @​emil9453, @​fintara, @​pascaliske, @​rramiachraf, @​marnusw and @​Imballinst for working on the release.

Fixed
Added
Changed

v2.8.1

Compare Source

Thanks to @​Imballinst for the bug fix!

Fixed

v2.8.0

Compare Source

Kudos to @​NaridaL, @​Zyten, @​Imballinst, @​leshakoss and @​Neorth for working on the release.

Fixed
Added

v2.7.0

Compare Source

Thanks to @​mzgajner, @​NaridaL, @​Zyten, @​leshakoss, @​fintara, @​kpr-hellofresh for contributing to the release.

Fixed
Changed
Added

v2.6.0

Compare Source

Kudos to @​marnusw, @​cdrikd and @​rogyvoje for working on the release!

Added

v2.5.1

Compare Source

Thanks to @​mitchellbutler for the bug fix!

Fixed

v2.5.0

Compare Source

Kudos to @​dkozickis, @​drugoi, @​kranthilakum, @​102, @​gpetrioli and @​JulienMalige for making the release happen.

Fixed
Added

v2.4.1

Compare Source

Thanks to @​mrclayman for reporting the issue and @​leshakoss for fixing it.

Fixed

v2.4.0

Compare Source

This release is brought to you by these amazing people: @​lovelovedokidoki, @​alexigityan, @​kalekseev and @​andybangs. You rock!

Fixed
Added

v2.3.0

Compare Source

Huge thanks to @​lovelovedokidoki who improved 8 (!) locales in an unstoppable open-source rampage and @​VesterDe for fixing Slovenian locale 👏

Fixed
Added

v2.2.1

Compare Source

Kudos to date-fns contributors: @​mzgajner, @​sibiraj-s, @​mukeshmandiwal, @​SneakyFish5 and @​CarterLi.

Added

v2.1.0

Compare Source

Thanks to date-fns contributors: @​ManadayM, @​illuminist, @​visualfanatic, @​vsaarinen and at last but not the least @​leshakoss!

Fixed
Added

v2.0.1

Compare Source

Fixed

v2.0.0

Compare Source

If you're upgrading from v2 alpha or beta, see the pre-release changelog.

Fixed

  • Fixed the toDate bug occurring when parsing ISO-8601 style dates (but not valid ISO format) with a trailing Z (e.g 2012-01Z), it returned Invalid Date for FireFox/IE11 #​510

  • Fixed differenceIn... functions returning negative zero in some cases: #​692

  • isDate now works properly with dates passed across iframes #​754.

  • Fixed a few bugs that appeared in timezones with offsets that include seconds (e.g. GMT+00:57:44). See MR #​789.

  • Fixed DST issue. See #​972 and #​992 for more details.

  • Fixed DST issue in eachDayOfInterval that caused time in the days after DST change to have the shift as well.

  • Fixed bug in Galician locale caused by incorrect usage of getHours instead of getUTCHours.

Changed

  • BREAKING: now functions don't accept string arguments, but only numbers or dates. When a string is passed, it will result in an unexpected result (Invalid Date, NaN, etc).

    From now on a string should be parsed using parseISO (ISO 8601) or parse.

    In v1 we've used new Date() to parse strings, but it resulted in many hard-to-track bugs caused by inconsistencies in different browsers. To address that we've implemented our ISO 8601 parser but that made library to significantly grow in size. To prevent inevitable bugs and keep the library tiny, we made this trade-off.

    See this post for more details.

    // Before v2.0.0
addDays("2016-01-01", 1);

// v2.0.0 onward
addDays(parseISO("2016-01-01"), 1);

  • BREAKING: new format string API for format function which is based on Unicode Technical Standard #​35. See this post for more details.

    Unit v2 Pattern v1 Pattern Result examples
    Era G..GGG AD, BC
    GGGG Anno Domini, Before Christ
    GGGGG A, B
    Calendar year y 44, 1, 1900, 2017
    yo 44th, 1st, 0th, 17th
    yy YY 44, 01, 00, 17
    yyy 044, 001, 1900, 2017
    yyyy YYYY 0044, 0001, 1900, 2017
    yyyyy ...
    Local week-numbering year Y 44, 1, 1900, 2017
    Yo 44th, 1st, 1900th, 2017th
    YY 44, 01, 00, 17
    YYY 044, 001, 1900, 2017
    YYYY 0044, 0001, 1900, 2017
    YYYYY ...
    ISO week-numbering year R -43, 0, 1, 1900, 2017
    RR GG -43, 00, 01, 1900, 2017
    RRR -043, 000, 001, 1900, 2017
    RRRR GGGG -0043, 0000, 0001, 1900, 2017
    RRRRR ...
    Extended year u -43, 0, 1, 1900, 2017
    uu -43, 01, 1900, 2017
    uuu -043, 001, 1900, 2017
    uuuu -0043, 0001, 1900, 2017
    uuuuu ...
    Quarter (formatting) Q 1, 2, 3, 4
    Qo 1st, 2nd, 3rd, 4th
    QQ 01, 02, 03, 04
    QQQ Q1, Q2, Q3, Q4
    QQQQ 1st quarter, 2nd quarter, ...
    QQQQQ 1, 2, 3, 4
    Quarter (stand-alone) q Q 1, 2, 3, 4
    qo Qo 1st, 2nd, 3rd, 4th
    qq 01, 02, 03, 04
    qqq Q1, Q2, Q3, Q4
    qqqq 1st quarter, 2nd quarter, ...
    qqqqq 1, 2, 3, 4
    Month (formatting) M 1, 2, ..., 12
    Mo 1st, 2nd, ..., 12th
    MM 01, 02, ..., 12
    MMM Jan, Feb, ..., Dec
    MMMM January, February, ..., December
    MMMMM J, F, ..., D
    Month (stand-alone) L M 1, 2, ..., 12
    Lo 1st, 2nd, ..., 12th
    LL MM 01, 02, ..., 12
    LLL MMM Jan, Feb, ..., Dec
    LLLL MMMM January, February, ..., December
    LLLLL J, F, ..., D
    Local week of year w 1, 2, ..., 53
    wo 1st, 2nd, ..., 53th
    ww 01, 02, ..., 53
    ISO week of year I W 1, 2, ..., 53
    Io Wo 1st, 2nd, ..., 53th
    II WW 01, 02, ..., 53
    Day of month d D 1, 2, ..., 31
    do Do 1st, 2nd, ..., 31st
    dd DD 01, 02, ..., 31
    Day of year D DDD 1, 2, ..., 365, 366
    Do DDDo 1st, 2nd, ..., 365th, 366th
    DD 01, 02, ..., 365, 366
    DDD DDDD 001, 002, ..., 365, 366
    DDDD ...
    Day of week (formatting) E..EEE Mon, Tue, Wed, ..., Su
    EEEE Monday, Tuesday, ..., Sunday
    EEEEE M, T, W, T, F, S, S
    EEEEEE Mo, Tu, We, Th, Fr, Sa, Su
    ISO day of week (formatting) i E 1, 2, 3, ..., 7
    io do 1st, 2nd, ..., 7th
    ii 01, 02, ..., 07
    iii ddd Mon, Tue, Wed, ..., Su
    iiii dddd Monday, Tuesday, ..., Sunday
    iiiii M, T, W, T, F, S, S
    iiiiii dd Mo, Tu, We, Th, Fr, Sa, Su
    Local day of week (formatting) e 2, 3, 4, ..., 1
    eo 2nd, 3rd, ..., 1st
    ee 02, 03, ..., 01
    eee Mon, Tue, Wed, ..., Su
    eeee Monday, Tuesday, ..., Sunday
    eeeee M, T, W, T, F, S, S
    eeeeee Mo, Tu, We, Th, Fr, Sa, Su
    Local day of week (stand-alone) c 2, 3, 4, ..., 1
    co 2nd, 3rd, ..., 1st
    cc 02, 03, ..., 01
    ccc Mon, Tue, Wed, ..., Su
    cccc Monday, Tuesday, ..., Sunday
    ccccc M, T, W, T, F, S, S
    cccccc Mo, Tu, We, Th, Fr, Sa, Su
    AM, PM a..aaa A AM, PM
    aaaa aa a.m., p.m.
    aaaaa a, p
    AM, PM, noon, midnight b..bbb AM, PM, noon, midnight
    bbbb a.m., p.m., noon, midnight
    bbbbb a, p, n, mi
    Flexible day period B..BBB at night, in the morning, ...
    BBBB at night, in the morning, ...
    BBBBB at night, in the morning, ...
    Hour [1-12] h 1, 2, ..., 11, 12
    ho 1st, 2nd, ..., 11th, 12th
    hh 01, 02, ..., 11, 12
    Hour [0-23] H 0, 1, 2, ..., 23
    Ho 0th, 1st, 2nd, ..., 23rd
    HH 00, 01, 02, ..., 23
    Hour [0-11] K 1, 2, ..., 11, 0
    Ko 1st, 2nd, ..., 11th, 0th
    KK 1, 2, ..., 11, 0
    Hour [1-24] k 24, 1, 2, ..., 23
    ko 24th, 1st, 2nd, ..., 23rd
    kk 24, 01, 02, ..., 23
    Minute m 0, 1, ..., 59
    mo 0th, 1st, ..., 59th
    mm 00, 01, ..., 59
    Second s 0, 1, ..., 59
    so 0th, 1st, ..., 59th
    ss 00, 01, ..., 59
    Fraction of second S 0, 1, ..., 9
    SS 00, 01, ..., 99
    SSS 000, 0001, ..., 999
    SSSS ...
    Timezone (ISO-8601 w/ Z) X -08, +0530, Z
    XX -0800, +0530, Z
    XXX -08:00, +05:30, Z
    XXXX -0800, +0530, Z, +123456
    XXXXX -08:00, +05:30, Z, +12:34:56
    Timezone (ISO-8601 w/o Z) x -08, +0530, +00
    xx ZZ -0800, +0530, +0000
    xxx Z -08:00, +05:30, +00:00
    xxxx -0800, +0530, +0000, +123456
    xxxxx -08:00, +05:30, +00:00, +12:34:56
    Timezone (GMT) O...OOO GMT-8, GMT+5:30, GMT+0
    OOOO GMT-08:00, GMT+05:30, GMT+00:00
    Timezone (specific non-locat.) z...zzz GMT-8, GMT+5:30, GMT+0
    zzzz GMT-08:00, GMT+05:30, GMT+00:00
    Seconds timestamp t X 5129695
    tt ...
    Milliseconds timestamp T x 5129695
    TT ...
    Long localized date P 5/29/53
    PP May 29, 1453
    PPP May 29th, 1453
    PPPP Sunday, May 29th, 1453
    Long localized time p 12:00 AM
    pp 12:00:00 AM
    ppp 12:00:00 AM GMT+2
    pppp 12:00:00 AM GMT+02:00
    Combination of date and time Pp 5/29/53, 12:00 AM
    PPpp May 29, 1453, 12:00 AM
    PPPppp May 29th, 1453 at ...
    PPPPpppp Sunday, May 29th, 1453 at ...

    Characters are now escaped using single quote symbols (') instead of square brackets. format now throws RangeError if it encounters an unescaped latin character that isn't a valid formatting token.

    To use YY and YYYY tokens that represent week-numbering years, you should set useAdditionalWeekYearTokens option:

    format(Date.now(), "YY", { useAdditionalWeekYearTokens: true });
//=> '86'

    To use D and DD tokens which represent days of the year, set useAdditionalDayOfYearTokens option:

    format(Date.now(), "D", { useAdditionalDayOfYearTokens: true });
//=> '364'

  • BREAKING: function submodules now use camelCase naming schema:

    // Before v2.0.0
import differenceInCalendarISOYears from "date-fns/difference_in_calendar_iso_years";

// v2.0.0 onward
import differenceInCalendarISOYears from "date-fns/differenceInCalendarISOYears";

  • BREAKING: min and max functions now accept an array of dates rather than spread arguments.

    // Before v2.0.0
var date1 = new Date(1989, 6 /* Jul */, 10);
var date2 = new Date(1987, 1 /* Feb */, 11);

var minDate = min(date1, date2);
var maxDate = max(date1, date2);

// v2.0.0 onward:
var dates = [
  new Date(1989, 6 /* Jul */, 10),
  new Date(1987, 1 /* Feb */, 11),
];

var minDate = min(dates);
var maxDate = max(dates);

  • BREAKING: make the second argument of format required for the sake of explicitness.

    // Before v2.0.0
format(new Date(2016, 0, 1));

// v2.0.0 onward
format(new Date(2016, 0, 1), "yyyy-MM-dd'T'HH:mm:ss.SSSxxx");

  • BREAKING renamed ISO week-numbering year helpers:

    • addISOYears → addISOWeekYears
    • differenceInCalendarISOYears → differenceInCalendarISOWeekYears
    • differenceInISOYears → differenceInISOWeekYears
    • endOfISOYear → endOfISOWeekYear
    • getISOYear → getISOWeekYear
    • isSameISOYear → isSameISOWeekYear
    • lastDayOfISOYear → lastDayOfISOWeekYear
    • setISOYear → setISOWeekYear
    • subISOYears → subISOWeekYears

    i.e. "ISO year" renamed to "ISO week year", which is short for ISO week-numbering year. It makes them consistent with locale-dependent week-numbering year helpers, e.g., startOfWeekYear.

  • BREAKING: functions renamed:

    • areRangesOverlapping → areIntervalsOverlapping
    • eachDay → eachDayOfInterval
    • getOverlappingDaysInRanges → getOverlappingDaysInIntervals
    • isWithinRange → isWithinInterval

    This change was made to mirror the use of the word "interval" in standard ISO 8601:2004 terminology:

    2.1.3
time interval
part of the time axis limited by two instants

    Also these functions now accept an object with start and end properties instead of two arguments as an interval. All these functions throw RangeError if the start of the interval is after its end or if any date in the interval is Invalid Date.

    // Before v2.0.0

areRangesOverlapping(
  new Date(2014, 0, 10),
  new Date(2014, 0, 20),
  new Date(2014, 0, 17),
  new Date(2014, 0, 21),
);

eachDay(new Date(2014, 0, 10), new Date(2014, 0, 20));

getOverlappingDaysInRanges(
  new Date(2014, 0, 10),
  new Date(2014, 0, 20),
  new Date(2014, 0, 17),
  new Date(2014, 0, 21),
);

isWithinRange(
  new Date(2014, 0, 3),
  new Date(2014, 0, 1),
  new Date(2014, 0, 7),
);

// v2.0.0 onward

areIntervalsOverlapping(
  { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
  { start: new Date(2014, 0, 17), end: new Date(2014, 0, 21) },
);

eachDayOfInterval({
  start: new Date(2014, 0, 10),
  end: new Date(2014, 0, 20),
});

getOverlappingDaysInIntervals(
  { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
  { start: new Date(2014, 0, 17), end: new Date(2014, 0, 21) },
);

isWithinInterval(new Date(2014, 0, 3), {
  start: new Date(2014, 0, 1),
  end: new Date(2014, 0, 7),
});

  • BREAKING: functions renamed:

    • distanceInWords → formatDistance
    • distanceInWordsStrict → formatDistanceStrict
    • distanceInWordsToNow → formatDistanceToNow

    to make them consistent with format and formatRelative.

  • BREAKING: The order of arguments of distanceInWords and distanceInWordsStrict is swapped to make them consistent with differenceIn... functions.

    // Before v2.0.0

distanceInWords(
  new Date(1986, 3, 4, 10, 32, 0),
  new Date(1986, 3, 4, 11, 32, 0),
  { addSuffix: true },
); //=> 'in about 1 hour'

// v2.0.0 onward

formatDistance(
  new Date(1986, 3, 4, 11, 32, 0),
  new Date(1986, 3, 4, 10, 32, 0),
  { addSuffix: true },
); //=> 'in about 1 hour'

  • BREAKING: partialMethod option in formatDistanceStrict is renamed to roundingMethod.

    // Before v2.0.0

distanceInWordsStrict(
  new Date(1986, 3, 4, 10, 32, 0),
  new Date(1986, 3, 4, 10, 33, 1),
  { partialMethod: "ceil" },
); //=> '2 minutes'

// v2.0.0 onward

formatDistanceStrict(
  new Date(1986, 3, 4, 10, 33, 1),
  new Date(1986, 3, 4, 10, 32, 0),
  { roundingMethod: "ceil" },
); //=> '2 minutes'

  • BREAKING: in formatDistanceStrict, if roundingMethod is not specified, it now defaults to round instead of floor.

  • BREAKING: unit option in formatDistanceStrict now accepts one of the strings: 'second', 'minute', 'hour', 'day', 'month' or 'year' instead of 's', 'm', 'h', 'd', 'M' or 'Y'

    // Before v2.0.0

distanceInWordsStrict(
  new Date(1986, 3, 4, 10, 32, 0),
  new Date(1986, 3, 4, 10, 33, 1),
  { unit: "m" },
);

// v2.0.0 onward

formatDistanceStrict(
  new Date(1986, 3, 4, 10, 33, 1),
  new Date(1986, 3, 4, 10, 32, 0),
  { unit: "minute" },
);

  • BREAKING: parse that previously used to convert strings and numbers to dates now parses only strings in an arbitrary format specified as an argument. Use toDate to coerce numbers and parseISO to parse ISO 8601 strings.

    // Before v2.0.0
parse("2016-01-01");
parse(1547005581366);
parse(new Date()); // Clone the date

// v2.0.0 onward
parse("2016-01-01", "yyyy-MM-dd", new Date());
parseISO("2016-01-01");
toDate(1547005581366);
toDate(new Date()); // Clone the date

  • BREAKING: toDate (previously parse) now doesn't accept string arguments but only numbers and dates. toDate called with an invalid argument will return Invalid Date.

  • BREAKING: new locale format. See docs/Locale. Locales renamed:

    • en → en-US
    • zh_cn → zh-CN
    • zh_tw → zh-TW 
    // Before v2.0.0
import locale from "date-fns/locale/zh_cn";

// v2.0.0 onward
import locale from "date-fns/locale/zh-CN";

  • BREAKING: now closestTo and closestIndexTo don't throw an exception when the second argument is not an array, and return Invalid Date instead.

  • BREAKING: now isValid doesn't throw an exception if the first argument is not an instance of Date. Instead, argument is converted beforehand using toDate.

    Examples:

    isValid argument Before v2.0.0 v2.0.0 onward
    new Date() true true
    new Date('2016-01-01') true true
    new Date('') false false
    new Date(1488370835081) true true
    new Date(NaN) false false
    '2016-01-01' TypeError false
    '' TypeError false
    1488370835081 TypeError true
    NaN TypeError false

    We introduce this change to make date-fns consistent with ECMAScript behavior that try to coerce arguments to the expected type (which is also the case with other date-fns functions).

  • BREAKING: functions now throw RangeError if optional values passed to options are not undefined or have expected values. This change is introduced for consistency with ECMAScript standard library which does the same.

  • BREAKING: format, formatDistance (previously distanceInWords) and formatDistanceStrict (previously distanceInWordsStrict) now throw RangeError if one of the passed arguments is invalid. It reflects behavior of toISOString and Intl API. See #​1032.

  • BREAKING: all functions now implicitly convert arguments by following rules:

    date number string boolean
    0 new Date(0) 0 '0' false
    '0' Invalid Date 0 '0' false
    1 new Date(1) 1 '1' true
    '1' Invalid Date 1 '1' true
    true Invalid Date NaN 'true' true
    false Invalid Date NaN 'false' false
    null Invalid Date NaN 'null' false
    undefined Invalid Date NaN 'undefined' false
    NaN Invalid Date NaN 'NaN' false

    Notes:

    • as before, arguments expected to be Date are converted to Date using date-fns' toDate function;
    • arguments expected to be numbers are converted to integer numbers using our custom toInteger implementation (see #​765);
    • arguments expected to be strings are converted to strings using JavaScript's String function;
    • arguments expected to be booleans are converted to boolean using JavaScript's Boolean function.

    null and undefined passed to optional arguments (i.e. properties of options argument) are ignored as if no argument was passed.

    If any resulting argument is invalid (i.e. NaN for numbers and Invalid Date for dates), an invalid value will be returned:

    • false for functions that return booleans (expect isValid);
    • Invalid Date for functions that return dates;
    • and NaN for functions that return numbers.

    See tests and MRs #​460 and #​765 for exact behavior.

  • BREAKING: all functions now check if the passed number of arguments is less than the number of required arguments and will throw TypeError exception if so.

  • BREAKING: all functions that accept numbers as arguments, now coerce values using Number() and also round off decimals. Positive decimals are rounded using Math.floor, decimals less than zero are rounded using Math.ceil.

  • BREAKING: The Bower & UMD/CDN package versions are no longer supported.

  • BREAKING: null now is not a valid date. isValid(null) returns false; toDate(null) returns an invalid date. Since toDate is used internally by all the functions, operations over null will also return an invalid date. See #​537 for the reasoning.

  • toDate (previously parse) and isValid functions now accept any type as the first argument.

  • Exclude docs.json from the npm package. Kudos to @​hawkrives.

Added

Configuration

📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

  • If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

Edited by Soos

Merge request reports