Skip to content

Latest commit

 

History

History
2561 lines (1635 loc) · 102 KB

CHANGELOG.md

File metadata and controls

2561 lines (1635 loc) · 102 KB
Raw

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

This change log follows the format documented in Keep a CHANGELOG.

v2.29.3 - 2022-09-13

This release is prepared by our own @leshakoss.

Fixed

v2.29.2 - 2022-08-18

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

Fixed

v2.29.1 - 2022-08-18

Thanks to @fturmel for working on the release.

Fixed

v2.29.0 - 2022-07-22

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 - 2021-12-28

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 - 2021-11-30

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 - 2021-11-19

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 - 2021-10-05

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

Added

v2.24.0 - 2021-09-17

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 - 2021-07-23

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 - 2021-05-28

Thanks to Sasha Koss for working on the release.

Fixed

  • Fixed constant typings. (#2491)

v2.22.0 - 2021-05-28

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 - 2021-05-08

This release is brought to you by Maxim Topciu.

Fixed

v2.21.2 - 2021-05-05

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

Fixed

v2.21.1 - 2021-04-15

Thanks to Sasha Koss for working on the release.

Fixed

v2.21.0 - 2021-04-14

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

Fixed

Added

v2.20.3 - 2021-04-13

Kudos to fturmel for working on the release.

Fixed

v2.20.2 - 2021-04-12

Kudos to Maxim Topciu for working on the release.

Fixed

v2.20.1 - 2021-04-09

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 - 2021-04-08

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 - 2021-03-05

Tan75 worked on this release.

Fixed

Added

v2.18.0 - 2021-03-01

Thanks to Tan75 and Lesha Koss.

Fixed

Added

[2.17.0] - 2021-02-05

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

Fixed

Added

2.16.1 - 2020-07-31

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

Fixed

2.16.0 - 2020-08-27

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

2.15.0 - 2020-07-17

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

2.14.0 - 2020-05-18

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

Fixed

Added

2.13.0 - 2020-05-06

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

Fixed

Added

2.12.0 - 2020-04-09

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

Fixed

Added

2.11.1 - 2020-03-26

Fixed

  • Rebuilt TypeScript and flow types.

2.11.0 - 2020-03-13

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

Fixed

Changed

Added

2.10.0 - 2020-02-25

Fixed

Fixed

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

Added

2.9.0 - 2020-01-08

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

2.8.1 - 2019-11-22

Thanks to @Imballinst for the bug fix!

Fixed

2.8.0 - 2019-11-19

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

Fixed

Added

2.7.0 - 2019-11-07

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

Fixed

Changed

Added

2.6.0 - 2019-10-22

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

Added

2.5.1 - 2019-10-18

Thanks to @mitchellbutler for the bug fix!

Fixed

2.5.0 - 2019-10-16

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

Fixed

Added

2.4.1 - 2019-09-28

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

Fixed

2.4.0 - 2019-09-27

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

Fixed

Added

2.3.0 - 2019-09-24

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

Fixed

Added

2.2.1 - 2019-09-12

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

Added

2.1.0 - 2019-09-06

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

Fixed

Added

2.0.1 - 2019-08-23

Fixed

2.0.0 - 2019-08-20

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 PR #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 512969520
    tt ...
    Milliseconds timestamp T x 512969520900
    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 PRs #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

[1.30.1] - 2018-12-10

Fixed

Added

Changed

[1.30.0] - 2018-12-10

⚠️ The release got failed.

[1.29.0] - 2017-10-11

Fixed

Added

1.28.5 - 2017-05-19

Fixed

  • Fixed a.m./p.m. formatters in Chinese Simplified locale. Thanks to @fnlctrl. See PR #486

1.28.4 - 2017-04-26

Fixed

  • Fixed accents on weekdays in the Italian locale. See PR #481. Thanks to @albertorestifo

  • Fixed typo in ddd format token in Spanish language locale. Kudos to @fjaguero. See PR #482

1.28.3 - 2017-04-14

Fixed

  • Fixed ordinal numbers for Danish language locale. Thanks to @kgram. See PR #474

1.28.2 - 2017-03-27

Fixed

  • Fixed dd and ddd formatters in Polish language locale. Kudos to @justrag. See PR: #467

1.28.1 - 2017-03-19

Fixed

  • Fixed DST border bug in addMilliseconds, addSeconds, addMinutes, addHours, subMilliseconds, subSeconds, subMinutes and subHours. See issue #465

  • Minor fix for Indonesian locale. Thanks to @bentinata. See PR: #458

1.28.0 - 2017-02-27

Added

Fixed

  • All functions now convert all their arguments to the respective types. See PR: #443

  • Fixes for ordinals (1er, 2, 3, …) in French locale. Thanks to @fbonzon. See PR: #449

1.27.2 - 2017-02-01

Fixed

  • Various fixes for Dutch locale. See PR: #416. Thanks to Ruben Stolk @rubenstolk

1.27.1 - 2017-01-20

Fixed

  • Added generation of TypeScript locale sub-modules, allowing import of locales in TypeScript.

1.27.0 - 2017-01-19

Added

1.26.0 - 2017-01-15

Added

  • getTime

Fixed

  • Various fixes for Japanese locale. See PR: 395. Thanks to Yamagishi Kazutoshi @ykzts

1.25.0 - 2017-01-11

Added

1.24.0 - 2017-01-06

Added

1.23.0 - 2017-01-05

Added

1.22.0 - 2016-12-28

Added

1.21.1 - 2016-12-18

Fixed

  • Fixed isBefore and isAfter documentation mistakes.

1.21.0 - 2016-12-16

Added

1.20.1 - 2016-12-14

Fixed

  • Fixed documentation for getOverlappingDaysInRanges.

1.20.0 - 2016-12-13

Added

  • areRangesOverlapping and getOverlappingDaysInRanges Thanks to Joanna T @asia-t. See PR: #331

1.19.0 - 2016-12-13

Added

1.18.0 - 2016-12-12

Added

Fixed

  • SS and SSS formats in format are now correctly displayed with leading zeros. Thanks to Paul Dijou @pauldijou. See PR: #330

1.17.0 - 2016-12-10

Added

Fixed

  • Fixed TypeScript and flow typings for isValid. See PR: #310

  • Fixed incorrect locale tests that could potentially lead to format bugs. Kudos to Mateusz Derks @ertrzyiks. See related PRs: #312, #320

  • Minor language fixes in the documentation. Thanks to Vedad Šoše @vedadsose (#314) and Asia @asia-t (#318)

Changed

  • format now returns String('Invalid Date') if the passed date is invalid. See PR: #323

  • distanceInWords, distanceInWordsToNow, distanceInWordsStrict and format functions now check if the passed locale is valid, and fallback to English locale otherwise. See PR: #321

  • Internal: use a loop instead of Object.keys in buildFormattingTokensRegExp to improve compatibility with older browsers. See PR: #322

1.16.0 - 2016-12-08

Added

1.15.1 - 2016-12-07

Fixed

  • Fixed TypeScript imports from individual modules. Thanks to @mattlewis92. See related PR: #287

1.15.0 - 2016-12-07

Added

Fixed

  • Fixed some inaccuracies in Spanish locale. Kudos to @guigrpa. See related PR: #302

1.14.1 - 2016-12-06

Fixed

  • Fixed broken test for Norwegian Bokmål locale.

1.14.0 - 2016-12-06

Added

1.13.0 - 2016-12-06

Added

1.12.1 - 2016-12-05

Fixed

  • Added distanceInWordsStrict to the list of supported functions in I18n doc.

1.12.0 - 2016-12-05

Added

Fixed

  • Fixed flow typings for some of the functions. See PR: #273

1.11.2 - 2016-11-28

Fixed

  • Bug in parse when it sometimes parses ISO week-numbering dates incorrectly. See PR: #262

  • Bug in some functions which caused them to handle dates earlier than 100 AD incorrectly. See PR: #263

1.11.1 - 2016-11-24

Fixed

  • Include TypeScript typings with npm package.

1.11.0 - 2016-11-23

Added

1.10.0 - 2016-11-01

Added

  • parse now can parse dates that are ISO 8601 centuries (e.g., 19 and +0019).

    var result = parse('19')
//=> Mon Jan 01 1900 00:00:00

  • In parse, added ability to specify the number of additional digits for extended year or century format (possible values are 0, 1 or 2; default is 2).

    parse('+002016-11-01')
parse('+02016-11-01', { additionalDigits: 1 })
parse('+2016-11-01', { additionalDigits: 0 })

1.9.0 - 2016-10-25

Added

  • Got index.js imports to work with SystemJS.

1.8.1 - 2016-10-24

Fixed

  • Added Japanese and German language locales to the list in I18n doc.

1.8.0 - 2016-10-23

Added

1.7.0 - 2016-10-20

Added

1.6.0 - 2016-10-16

Added

1.5.2 - 2016-10-13

Fixed

  • Incorrectly generated docs for format.

  • Fixed typo in I18n doc.

1.5.1 - 2016-10-12

Fixed

  • A change log entry for 1.5.0 is added.

1.5.0 - 2016-10-12

Added

1.4.0 - 2016-10-09

Added

Fixed

  • Fixed incorrect behaviour of YYYY and YY for years prior to 1000: now format(new Date('0001-01-01'), 'YYYY-MM-DD') returns 0001-01-01 instead of 1-01-01.

1.3.0 - 2016-05-26

Added

  • closestIndexTo

1.2.0 - 2016-05-23

Added

  • Added an ability to pass negative numbers to setDay.

1.1.1 - 2016-05-19

Fixed

  • Fixed Flow declarations for some of the functions.

1.1.0 - 2016-05-19

Added

1.0.0 - 2016-05-18

Fixed

  • format now returns the correct result for key E.

  • Prevent startOf..., endOf... and lastDayOf... functions to return dates with an incorrect time when the date is modifying into another time zone.

  • parse now parses years from 1 AD to 99 AD correctly.

  • Fix a bug in getISOWeek appearing because of a changing time zone (e.g., when the given date is in DST and the start of the ISO year is not).

Changed

  • BREAKING: all functions are moved to the root of the library, so they are now accessible with require('date-fns/name_of_function') or import nameOfFunction from 'date-fns/name_of_function'.

    // Before v1.0.0
var addMonths = require('date-fns/src/add_months')

// v1.0.0 onward
var addMonths = require('date-fns/add_months')

  • BREAKING: functions that had the last optional argument weekStartsAt (i.e. endOfWeek, isSameWeek, lastDayOfWeek, setDay, startOfWeek) now instead receive the object options with the property options.weekStartsOn as the last argument.

    // Before v1.0.0
var result = endOfWeek(new Date(2014, 8, 2), 1)

// v1.0.0 onward
var result = endOfWeek(new Date(2014, 8, 2), { weekStartsOn: 1 })

  • BREAKING: remove the function getTimeSinceMidnight that was used inside the other functions.

  • BREAKING: differenceInDays now returns the number of full days instead of calendar days.

  • BREAKING: eachDay and isWithinRange now throw an exception when the given range boundaries are invalid.

  • Faster isLeapYear.

  • Internal: make the documentation more verbose.

  • Internal: convert the tests from Chai to power-assert allowing them to run against IE8.

Added

  • addISOYears

  • closestTo

  • differenceInCalendarDays

  • differenceInCalendarISOWeeks

  • differenceInCalendarISOYears

  • differenceInCalendarMonths

  • differenceInCalendarQuarters

  • differenceInCalendarWeeks

  • differenceInCalendarYears

  • differenceInHours

  • differenceInISOYears

  • differenceInMilliseconds

  • differenceInMinutes

  • differenceInMonths

  • differenceInQuarters

  • differenceInSeconds

  • differenceInWeeks

  • differenceInYears

  • distanceInWords

  • distanceInWordsToNow

  • endOfISOWeek

  • endOfISOYear

  • endOfToday

  • endOfTomorrow

  • endOfYesterday

  • getDaysInYear

  • isDate

  • isFriday

  • isMonday

  • isSameISOWeek

  • isSameISOYear

  • isSaturday

  • isSunday

  • isThisHour

  • isThisISOWeek

  • isThisISOYear

  • isThisMinute

  • isThisMonth

  • isThisQuarter

  • isThisSecond

  • isThisWeek

  • isThisYear

  • isThursday

  • isTomorrow

  • isTuesday

  • isValid

  • isWednesday

  • isYesterday

  • lastDayOfISOWeek

  • lastDayOfISOYear

  • startOfISOWeek

  • startOfToday

  • startOfTomorrow

  • startOfYesterday

  • subISOYears

  • Add Qo, W, Wo, WW, GG, GGGG, Z, ZZ, X, x keys to format.

0.17.0 - 2015-09-29

Fixed

  • Fixed a lot of bugs appearing when date is modifying into other time zone (e.g., when adding months and original date is in DST but new date is not).

  • Prevent instances of Date to lose milliseconds value when passed to. parse in IE10.

Changed

  • setISOWeek now keeps time from original date.

  • Internal: reuse getDaysInMonth inside of addMonths.

Added

  • differenceInDays

  • getTimeSinceMidnight

  • format now has new format key aa, which returns a.m./p.m. as opposed to a that returns am/pm.

  • Complete UMD package (for Bower and CDN).

0.16.0 - 2015-09-01

Changed

  • Use parse to clean date arguments in all functions.

  • parse now fallbacks to new Date when the argument is not an ISO formatted date.

  • Internal: reuse getDaysInMonth inside of setMonth.

Added

  • addQuarters

  • addWeeks

  • endOfQuarter

  • getDate

  • getDay

  • getDaysInMonth

  • getHours

  • getISOWeeksInYear

  • getMilliseconds

  • getMinutes

  • getMonth

  • getSeconds

  • getYear

  • isLeapYear

  • isSameHour

  • isSameMinute

  • isSameQuarter

  • isSameSecond

  • lastDayOfQuarter

  • lastDayOfWeek

  • max

  • min

  • setDate

  • setDay

  • setHours

  • setMilliseconds

  • setMinutes

  • setSeconds

  • startOfQuarter

  • subQuarters

  • subWeeks

0.15.0 - 2015-08-26

Changed

  • format now returns a.m./p.m. instead of am/pm.

  • setMonth now sets last day of month if original date was last day of longer month.

  • Internal: Fix code style according to ESLint.

  • Internal: Make tests run through all time zones.

Added

  • getQuarter

  • setQuarter

  • getDayOfYear

  • setDayOfYear

  • isPast

  • addSeconds

  • subSeconds

  • startOfSecond

  • endOfSecond

  • startOfMinute

  • endOfMinute

  • addMilliseconds

  • subMilliseconds

  • endOfYear

  • addYears

  • subYears

  • lastDayOfYear

  • lastDayOfMonth

0.14.11 - 2015-08-21

Fixed

  • format now uses parse to avoid time zone bugs.

Changed

  • setIsoWeek now sets time to the start of the day.

0.14.10 - 2015-07-29

Fixed

  • format now behaves correctly with 12:00 am.

  • format now behaves correctly with ordinal numbers.

Added

  • compareAsc

  • compareDesc

  • addHours

  • subHours

  • isSameDay

  • parse

  • getISOYear

  • setISOYear

  • startOfISOYear

  • getISOWeek

  • setISOWeek

0.14.9 - 2015-01-14

Fixed

  • addMonths now correctly behaves with February (see #18).

0.14.8 - 2014-12-25

Fixed

  • format function now behaves correctly with pm/am.

0.14.6 - 2014-12-04

Fixed

  • Fix broken Bower support.

0.14.0 - 2014-11-05

Added

  • Bower package.

0.13.0 - 2014-10-22

Added

  • addMinutes

  • subMinutes

  • isEqual

  • isBefore

  • isAfter

0.12.1 - 2014-10-19

Fixed

  • Incorrect rounding in DDD formatter.

0.12.0 - 2014-10-15

Added

  • isSameYear

0.11.0 - 2014-10-15

Added

  • isWithinRange

0.10.0 - 2014-10-13

Added

  • format

  • startOfYear

0.9.0 - 2014-10-10

Changed

  • Internal: simplify isWeekend

Added

  • isFuture

0.8.0 - 2014-10-09

Changed

  • Internal: reuse addDays inside of subDays.

Added

  • addMonths

  • subMonths

  • setMonth

  • setYear

0.7.0 - 2014-10-08

Added

  • isSameWeek

0.6.0 - 2014-10-07

Fixed

  • Inconsistent behavior of endOfMonth.

Added

  • isFirstDayOfMonth

  • isLastDayOfMonth

  • isSameMonth

0.5.0 - 2014-10-07

Added

  • addDays

  • subDays

0.4.0 - 2014-10-07

Added

  • startOfWeek

  • endOfWeek

  • eachDay

0.3.0 - 2014-10-06

Changed

  • startOfDay now sets milliseconds as well.

Added

  • endOfDay

  • startOfMonth

  • endOfMonth

0.2.0 - 2014-10-06

Added

  • isToday

  • isWeekend

0.1.0 - 2014-10-06

Added

  • startOfDay