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.
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 DST issues with
add
,addDays
andaddMonths
. - Fixed "quarter" translation in the Bulgarian locale.
- Fixed
formatDistance
strings in the Hungarian locale. - Fixed Danish month abbreviations.
- Fixed parsing of mei in the Dutch locale.
- Fixed missing preposition in
formatLong
in the Spanish locale. - Fixed
formatRelative
in the Italian locale.
- Added
eachQuarterOfInterval
. - Added Basque (
eu
) locale. - Added Indian English (
en-IN
) locale. - Added
eachHourOfInterval
.
2.13.0 - 2020-05-06
Thanks to @JorenVos, @developergouli, @rhlowe and @justingrant for working on the release!
2.12.0 - 2020-04-09
Kudos to @leshakoss, @skyuplam, @so99ynoodles, @dkozickis, @belgamo, @akgondber, @dcousens and @BoomDev for working on the release!
- Fixed minulý štvrtok in Slovak locale.
- Fixed date ordinalNumber for ja/zh-CN/zh-TW and ko.
- Fixed quarters parsing.
- Fixed
setDay
withweekStartsOn
!= 0. - Fixed differenceInDays across DST.
- Fixed required arguments exception message.
2.11.1 - 2020-03-26
- 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 a bug in
differenceInYears
causing incorrect results when the left date is a leap day. - Fixed
parseISO
to work correctly around time shift dates. - Fixed
format
to work correctly with GMT-0752/GMT-0456 and similar timezones.
- Changed
getDay
typings to return0|1|2|3|4|5|6
instead ofnumber
. - Improved Chinese locale:
- Change date format to meet the national standard (GB/T 7408-2005).
- Improve
ordinalNumber
function behavior. - Add prefix in
formatRelative
depending on if it's a current week or not.
2.10.0 - 2020-02-25
- Fixed a bug in setDay when using weekStartsOn that is not 0
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 a bug with addBusinessDays returning the Tuesday when adding 1 day on weekends. Now it returns the Monday.
- Added missing timezone to
formatISO
. - Removed dots from short day period names in the Kazakh locale.
- Fixed typo in formatDistance in the Czech locale.
- Fixed shortenings in the Bulgarian locale.
- Fixed regex for the May in the Portuguese locale.
- Added
eachMonthOfInterval
andeachYearOfInterval
. - Added
inclusive
option to `areIntervalsOverlapping. - Added
isExists
function that checks if the given date is exists. - Added
add
function to add seconds, minutes, hours, weeks, years in single call. - Added
sub
function, the opposite ofadd
. - Added
Duration
type used inadd
andsub
. - Added Azerbaijani (az) locale.
- Added Moroccan Arabic (ar-MA) locale.
- Reduced the total minified build size by 1Kb/4%.
- Made all properties in
Locale
type optional. - Added missing properties to
Locale
type. - Add the locale code to
Locale
type. - Added support of space time separator to
parseJSON
. - Allowed up to 7 digits in milliseconds in
parseJSON
.
2.8.1 - 2019-11-22
Thanks to @Imballinst for the bug fix!
2.8.0 - 2019-11-19
Kudos to @NaridaL, @Zyten, @Imballinst, @leshakoss and @Neorth for working on the release.
- Added Malay (ms) locale.
- Added
formatISO
,formatISO9075
,formatRFC3339
, andformatRFC7231
functions.
2.7.0 - 2019-11-07
Thanks to @mzgajner, @NaridaL, @Zyten, @leshakoss, @fintara, @kpr-hellofresh for contributing to the release.
- Fixed a mistake in the Slovenian locale.
- Fixed incorrect behavior of
parseISO
in Firefox caused by differences ingetTimezoneOffset
.
- Make object arguments types more elaborate in Flow type definitions.
- Get rid of deprecated Function in Flow type definitions.
- Allow
parseJSON
to accept strings without trailing 'Z' symbol and with up to 6 digits in the milliseconds' field.
2.6.0 - 2019-10-22
Kudos to @marnusw, @cdrikd and @rogyvoje for working on the release!
- Added
parseJSON
- lightweight function (just 411 B) that parses dates formatted withtoJSON
. - Added the language code to each locale.
- Added
subBusinessDays
function. - Added both Serbian - cyrillic (sr) and latin (sr-Latn) locales.
2.5.1 - 2019-10-18
Thanks to @mitchellbutler for the bug fix!
2.5.0 - 2019-10-16
Kudos to @dkozickis, @drugoi, @kranthilakum, @102, @gpetrioli and @JulienMalige for making the release happen.
- Added Kazakh (kk) locale.
- Added Telugu (te) locale.
- Added Canadian French (fr-CA) locale.
- Added Australian English (en-AU) locale.
- Exported
Interval
andLocale
types from Flow typings.
2.4.1 - 2019-09-28
Thanks to @mrclayman for reporting the issue and @leshakoss for fixing it.
2.4.0 - 2019-09-27
This release brought to you by these amazing people: @lovelovedokidoki, @alexigityan, @kalekseev and @andybangs. You rock!
- Fixed Vietnamese parsing patterns.
- Fixed Czech parsing regexes.
- Fixed offset for Eastern Hemisphere in
parseISO
.
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 the translation of "yesterday" in the Slovenian locale.
- Fixed French parsing issues with June and August.
- Improved Turkish parsing.
- Fixed "March" in Dutch parsing patterns.
- Fixed Hindi parsing patterns.
- Added Finnish matching patterns.
- Accept abbreviated March, June, July in Norwegian locales.
- Added parsing for Greek months with long formatting.
2.2.1 - 2019-09-12
Kudos to date-fns contributors: @mzgajner, @sibiraj-s, @mukeshmandiwal, @SneakyFish5 and @CarterLi.
- Added new
set
function. - Updated Slovenian (sl) locale for v2.
- Added Tamil (ta) locale.
- Added Hindi (hi) locale.
- Added support of
\n
informat
,lightFormat
andparse
.
2.1.0 - 2019-09-06
Thanks to date-fns contributors: @ManadayM, @illuminist, @visualfanatic, @vsaarinen and at least but not least @leshakoss!
- Set start of the week to the Sunday for Thai locale.
- Fixed month matching in Polish locale.
- Fixed
eachWeekendOfInterval
skipping the first date in the supplied interval.
2.0.1 - 2019-08-23
- Fix
getWeekOfMonth
withoptions.weekStartsOn
set to 1 not working for Sundays. Kudos to @waseemahmad31!
2.0.0 - 2019-08-20
If you're upgrading from v2 alpha or beta, see the pre-release changelog.
-
Fix the
toDate
bug occurring when parsing ISO-8601 style dates (but not valid ISO format) with a trailing Z (e.g2012-01Z
), it returned Invalid Date for FireFox/IE11 #510 -
Fix
differenceIn...
functions returning negative zero in some cases: #692 -
isDate
now works properly with dates passed across iframes #754. -
Fix a few bugs that appear 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. -
Fix bug in Galician locale caused by incorrect usage of
getHours
instead ofgetUTCHours
.
-
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) orparse
.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, Su, Sa 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, Su, Sa 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, Su, Sa 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, Su, Sa 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
andYYYY
tokens that represent week-numbering years, you should setuseAdditionalWeekYearTokens
option:format(Date.now(), 'YY', { useAdditionalWeekYearTokens: true }) //=> '86'
To use
D
andDD
tokens which represent days of the year, setuseAdditionalDayOfYearTokens
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
andend
properties instead of two arguments as an interval. All these functions throwRangeError
if the start of the interval is after its end or if any date in the interval isInvalid 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
andformatRelative
. -
BREAKING: The order of arguments of
distanceInWords
anddistanceInWordsStrict
is swapped to make them consistent withdifferenceIn...
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 informatDistanceStrict
is renamed toroundingMethod
.// 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
, ifroundingMethod
is not specified, it now defaults toround
instead offloor
. -
BREAKING:
unit
option informatDistanceStrict
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 parse only strings in an arbitrary format specified as an argument. UsetoDate
to coerce numbers andparseISO
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
(previouslyparse
) now doesn't accept string arguments but only numbers and dates.toDate
called with an invalid argument will returnInvalid 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
andclosestIndexTo
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 usingtoDate
.Examples:
isValid
argumentBefore 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 tooptions
are notundefined
or have expected values. This change is introduced for consistency with ECMAScript standard library which does the same. -
BREAKING:
format
,formatDistance
(previouslydistanceInWords
) andformatDistanceStrict
(previouslydistanceInWordsStrict
) now throwRangeError
if one the passed arguments is invalid. It reflects behavior oftoISOString
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 toDate
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
andundefined
passed to optional arguments (i.e. properties ofoptions
argument) are ignored as if no argument was passed.If any resulting argument is invalid (i.e.
NaN
for numbers andInvalid Date
for dates), an invalid value will be returned:false
for functions that return booleans (expectisValid
);Invalid Date
for functions that return dates;- and
NaN
for functions that return numbers.
- as before, arguments expected to be
-
BREAKING: all functions now check if the passed number of arguments is less than the number of required arguments and throw
TypeError
exception if so. -
BREAKING: all functions that accept numbers as arguments, now coerce values using
Number()
and also round decimals. Positive decimals are rounded usingMath.floor
, decimals less than zero are rounded usingMath.ceil
. -
BREAKING: The Bower & UMD/CDN package versions are no longer supported.
-
BREAKING:
null
now is not a valid date.isValid(null)
returnsfalse
;toDate(null)
returns an invalid date. SincetoDate
is used internally by all the functions, operations overnull
will also return an invalid date. See #537 for the reasoning. -
toDate
(previouslyparse
) andisValid
functions now acceptany
type as the first argument. -
Exclude
docs.json
from the npm package. Kudos to @hawkrives.
-
FP functions like those in lodash, that support currying, and, as a consequence, functional-style function composing.
Functions with options (
format
,parse
, etc.) have two FP counterparts: one that has the options object as its first argument and one that hasn't. The name of the former hasWithOptions
added to the end of its name.In FP functions, the order of arguments is reversed.
See FP Guide for more information.
import addYears from 'date-fns/fp/addYears' import formatWithOptions from 'date-fns/fp/formatWithOptions' import eo from 'date-fns/locale/eo' // If FP function has not received enough arguments, it returns another function const addFiveYears = addYears(5) // Several arguments can be curried at once const dateToString = formatWithOptions({ locale: eo }, 'd MMMM yyyy') const dates = [ new Date(2017, 0 /* Jan */, 1), new Date(2017, 1 /* Feb */, 11), new Date(2017, 6 /* Jul */, 2) ] const formattedDates = dates.map(date => dateToString(addFiveYears(date))) //=> ['1 januaro 2022', '11 februaro 2022', '2 julio 2022']
-
Added support for ECMAScript Modules.
It allows usage with bundlers that support tree-shaking, like rollup.js and webpack:
// Without tree-shaking: import format from 'date-fns/format' import parse from 'date-fns/parse' // With tree-shaking: import { format, parse } from 'date-fns'
Also, ESM functions provide default export, they can be used with TypeScript to import functions in more idiomatic way:
// Before import * as format from 'date-fns/format' // Now import format from 'date-fns/format'
-
formatRelative
function. See formatRelative -
Flow typings for
index.js
,fp/index.js
,locale/index.js
, and their ESM equivalents. See PR #558 -
New locale-dependent week-numbering year helpers:
-
getWeek
-
getWeekYear
-
setWeek
-
setWeekYear
-
startOfWeekYear
-
-
Added
eachWeekOfInterval
, the weekly equivalent ofeachDayOfInterval
-
Added
getUnixTime
function. Kudos to @Kingwl. -
New decade helpers. Thanks to @y-nk!
-
getDecade
-
startOfDecade
-
endOfDecade
-
lastDayOfDecade
-
-
New
roundToNearestMinutes
function. Kudos to @xkizer. -
Added new function
fromUnixTime
. Thansk to @xkizer. -
New interval, month, and year helpers to fetch a list of all Saturdays and Sundays (weekends) for a given date interval.
eachWeekendOfInterval
is the handler function while the other two are wrapper functions. Kudos to @laekettavong!-
eachWeekendOfInterval
-
eachWeekendOfMonth
-
eachWeekendOfYear
-
-
Build-efficient
lightFormat
that only supports the popular subset of tokens. See #1050. -
parseISO
function that parses ISO 8601 strings. See #1023. -
Add constants that can be imported directly from
date-fns
or the submoduledate-fns/constants
:-
maxTime
-
minTime
-
-
New locales:
-
Add new function
differenceInBusinessDays
which calculates the difference in business days. Kudos to @ThorrStevens! -
Add new function
addBusinessDays
, similar toaddDays
but ignoring weekends. Thanks to @ThorrStevens!
-
Fixed DST issue. See #972 and #992 for more details. This fix was backported from v2.
-
Fix a few bugs that appear in timezones with offsets that include seconds (e.g. GMT+00:57:44). See PR #789. This fix was backported from v2.
-
Fix misspelled January in the Thai locale. Thanks to @ratchapol-an!
-
Added Serbian locale. Kudos to @mawi12345!
-
Added Belarusian locale. Kudos to @mawi12345 again!
- Improve ja translation of distanceInWords. Thanks to @kudohamu!
- Fix Italian translations for
formatDistance
. (see the issue: #550; see the PR: #552) Thanks to @giofilo!
-
Hungarian locale (hu) (thanks to László Horváth @horvathlg)
-
Slovenian locale (sl) (thanks to Adam Stradovnik @Neoglyph)
-
Add
step
toeachDay
function. Thanks to @BDav24. See PR #487.
1.28.5 - 2017-05-19
1.28.4 - 2017-04-26
-
Fix accents on weekdays in the Italian locale. See PR #481. Thanks to @albertorestifo
-
Fix typo in
ddd
format token in Spanish language locale. Kudos to @fjaguero. See PR #482
1.28.3 - 2017-04-14
1.28.2 - 2017-03-27
1.28.1 - 2017-03-19
-
Fix DST border bug in
addMilliseconds
,addSeconds
,addMinutes
,addHours
,subMilliseconds
,subSeconds
,subMinutes
andsubHours
. See issue #465 -
Minor fix for Indonesian locale. Thanks to @bentinata. See PR: #458
1.28.0 - 2017-02-27
- Romanian locale (ro) (thanks to Sergiu Munteanu @jsergiu)
-
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
- Various fixes for Dutch locale. See PR: #416. Thanks to Ruben Stolk @rubenstolk
1.27.1 - 2017-01-20
- Added generation of TypeScript locale sub-modules, allowing import of locales in TypeScript.
1.27.0 - 2017-01-19
- Macedonian locale (mk) (thanks to Petar Vlahu @vlahupetar)
1.26.0 - 2017-01-15
getTime
1.25.0 - 2017-01-11
-
Bulgarian locale (bg) (thanks to Nikolay Stoynov @arvigeus)
-
Czech locale (cs) (thanks to David Rus @davidrus)
1.24.0 - 2017-01-06
- Modern Standard Arabic locale (ar) (thanks to Abdallah Hassan @AbdallahAHO)
1.23.0 - 2017-01-05
-
Auto generate TypeScript and flow typings from documentation on release. Thanks to @mattlewis92. See related PRs: #355, #370
-
Croatian locale (hr) (thanks to Matija Marohnić @silvenon)
-
Thai locale (th) (thanks to Athiwat Hirunworawongkun @athivvat)
-
Finnish locale (fi) (thanks to Pyry-Samuli Lahti @Pyppe)
1.22.0 - 2016-12-28
- Icelandic locale (is) (thanks to Derek Blank @derekblank)
1.21.1 - 2016-12-18
- Fix
isBefore
andisAfter
documentation mistakes.
1.21.0 - 2016-12-16
-
Filipino locale (fil) (thanks to Ian De La Cruz @RIanDeLaCruz)
-
Danish locale (da) (kudos to Anders B. Hansen @Andersbiha)
1.20.1 - 2016-12-14
- Fix documentation for
getOverlappingDaysInRanges
.
1.20.0 - 2016-12-13
1.19.0 - 2016-12-13
-
Greek locale (el) (kudos to Theodoros Orfanidis @teoulas)
-
Slovak locale (sk) (kudos to Marek Suscak @mareksuscak)
-
Add yarn support. Thanks to Uladzimir Havenchyk @havenchyk. See PR: #288
1.18.0 - 2016-12-12
-
Turkish locale (tr) (kudos to Alpcan Aydın @alpcanaydin)
-
Korean locale (ko) (thanks to Hong Chulju @angdev)
SS
andSSS
formats informat
are now correctly displayed with leading zeros. Thanks to Paul Dijou @pauldijou. See PR: #330
1.17.0 - 2016-12-10
-
Polish locale (pl) (thanks to Mateusz Derks @ertrzyiks)
-
Portuguese locale (pt) (thanks to Dário Freire @dfreire)
-
Swedish locale (sv) (thanks to Johannes Ulén @ejulen)
-
French locale (fr) (thanks to Jean Dupouy @izeau)
-
Performance tests. See PR: #289
-
Fix TypeScript and flow typings for
isValid
. See PR: #310 -
Fix 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)
-
format
now returnsString('Invalid Date')
if the passed date is invalid. See PR: #323 -
distanceInWords
,distanceInWordsToNow
,distanceInWordsStrict
andformat
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
inbuildFormattingTokensRegExp
to improve compatibility with older browsers. See PR: #322
1.16.0 - 2016-12-08
-
Italian locale (it) (thanks to Alberto Restifo @albertorestifo)
-
For German
buildDistanceInWordsLocale
, add nominative case translations (for distances without a suffix). Kudos to Asia @asia-t. See related PR: #295
1.15.1 - 2016-12-07
- Fixed TypeScript imports from individual modules. Thanks to @mattlewis92. See related PR: #287
1.15.0 - 2016-12-07
-
Indonesian locale (id) (thanks to Rahmat Budiharso @rbudiharso)
-
Catalan locale (ca) (thanks to Guillermo Grau @guigrpa)
1.14.1 - 2016-12-06
- Fixed broken test for Norwegian Bokmål locale.
1.14.0 - 2016-12-06
- Norwegian Bokmål locale (nb) (thanks to Hans-Kristian Koren @Hanse)
1.13.0 - 2016-12-06
-
Chinese Traditional locale (zh_tw) (thanks to tonypai @tpai).
-
Dutch language locale (nl) (kudos to Jorik Tangelder @jtangelder)
1.12.1 - 2016-12-05
- Added
distanceInWordsStrict
to the list of supported functions in I18n doc.
1.12.0 - 2016-12-05
- Spanish language locale (es) (thanks to Juan Angosto @juanangosto).
- Fix flow typings for some of the functions. See PR: #273
1.11.2 - 2016-11-28
-
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
- Include TypeScript typings with npm package.
1.11.0 - 2016-11-23
-
distanceInWordsStrict
. Kudos to @STRML. See related PR: #254 -
TypeScript typings for all functions. Kudos to @mattlewis92. See related PR: #255
1.10.0 - 2016-11-01
-
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
- Got index.js imports to work with SystemJS.
1.8.1 - 2016-10-24
- Added Japanese and German language locales to the list in I18n doc.
1.8.0 - 2016-10-23
-
Japanese language locale (ja) (thanks to Thomas Eilmsteiner @DeMuu again!)
-
getISODay
-
setISODay
1.7.0 - 2016-10-20
- German language locale (de) (thanks to Thomas Eilmsteiner @DeMuu).
1.6.0 - 2016-10-16
- Chinese Simplified locale (zh_cn) (kudos to Changyu @KingMario Geng).
1.5.2 - 2016-10-13
-
Incorrectly generated docs for
format
. -
Fixed typo in I18n doc.
1.5.1 - 2016-10-12
- A change log entry for 1.5.0 is added.
1.5.0 - 2016-10-12
1.4.0 - 2016-10-09
- Basic SystemJS support.
- Fix incorrect behaviour of
YYYY
andYY
for years prior to 1000: nowformat(new Date('0001-01-01'), 'YYYY-MM-DD')
returns0001-01-01
instead of1-01-01
.
1.3.0 - 2016-05-26
closestIndexTo
1.2.0 - 2016-05-23
- Add an ability to pass negative numbers to
setDay
.
1.1.1 - 2016-05-19
- Fix Flow declarations for some of the functions.
1.1.0 - 2016-05-19
-
Flow declarations for each function in the ".js.flow" style. Kudos to @JohnyDays. See related PRs:
1.0.0 - 2016-05-18
-
format
now returns the correct result for keyE
. -
Prevent
startOf...
,endOf...
andlastDayOf...
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).
-
BREAKING: all functions are moved to the root of the library, so they are now accessible with
require('date-fns/name_of_function')
orimport 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 objectoptions
with the propertyoptions.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
andisWithinRange
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.
-
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 toformat
.
0.17.0 - 2015-09-29
-
Fix 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.
-
setISOWeek
now keeps time from original date. -
Internal: reuse
getDaysInMonth
inside ofaddMonths
.
-
differenceInDays
-
getTimeSinceMidnight
-
format
now has new format keyaa
, which returnsa.m.
/p.m.
as opposed toa
that returnsam
/pm
. -
Complete UMD package (for Bower and CDN).
0.16.0 - 2015-09-01
-
Use
parse
to clean date arguments in all functions. -
parse
now fallbacks tonew Date
when the argument is not an ISO formatted date. -
Internal: reuse
getDaysInMonth
inside ofsetMonth
.
-
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
-
format
now returnsa.m.
/p.m.
instead ofam
/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.
-
getQuarter
-
setQuarter
-
getDayOfYear
-
setDayOfYear
-
isPast
-
addSeconds
-
subSeconds
-
startOfSecond
-
endOfSecond
-
startOfMinute
-
endOfMinute
-
addMilliseconds
-
subMilliseconds
-
endOfYear
-
addYears
-
subYears
-
lastDayOfYear
-
lastDayOfMonth
0.14.11 - 2015-08-21
format
now usesparse
to avoid time zone bugs.
setIsoWeek
now sets time to the start of the day.
0.14.10 - 2015-07-29
-
format
now behaves correctly with 12:00 am. -
format
now behaves correctly with ordinal numbers.
-
compareAsc
-
compareDesc
-
addHours
-
subHours
-
isSameDay
-
parse
-
getISOYear
-
setISOYear
-
startOfISOYear
-
getISOWeek
-
setISOWeek
0.14.9 - 2015-01-14
addMonths
now correctly behaves with February (see #18).
0.14.8 - 2014-12-25
format
function now behaves correctly withpm
/am
.
0.14.6 - 2014-12-04
- Fix broken Bower support.
0.14.0 - 2014-11-05
- Bower package.
0.13.0 - 2014-10-22
-
addMinutes
-
subMinutes
-
isEqual
-
isBefore
-
isAfter
0.12.1 - 2014-10-19
- Incorrect rounding in
DDD
formatter.
0.12.0 - 2014-10-15
isSameYear
0.11.0 - 2014-10-15
isWithinRange
0.10.0 - 2014-10-13
-
format
-
startOfYear
0.9.0 - 2014-10-10
- Internal: simplify
isWeekend
isFuture
0.8.0 - 2014-10-09
- Internal: reuse
addDays
inside ofsubDays
.
-
addMonths
-
subMonths
-
setMonth
-
setYear
0.7.0 - 2014-10-08
isSameWeek
0.6.0 - 2014-10-07
- Inconsistent behavior of
endOfMonth
.
-
isFirstDayOfMonth
-
isLastDayOfMonth
-
isSameMonth
0.5.0 - 2014-10-07
-
addDays
-
subDays
0.4.0 - 2014-10-07
-
startOfWeek
-
endOfWeek
-
eachDay
0.3.0 - 2014-10-06
startOfDay
now sets milliseconds as well.
-
endOfDay
-
startOfMonth
-
endOfMonth
0.2.0 - 2014-10-06
-
isToday
-
isWeekend
startOfDay