fix(deps): update dependency date-fns to v4
This PR contains the following updates:
| Package | Change | Age | Confidence |
|---|---|---|---|
| date-fns | ^2.0.0-alpha.24 -> ^4.1.0 |
Test plan: CI should pass with updated dependencies. No review required: this is an automated dependency update PR.
Release Notes
date-fns/date-fns (date-fns)
v4.1.0
This release adds time zone support to format functions (that I somehow missed when working on the feature) and fixes a few bugs.
Make sure also upgrade TZDate to v1.0.2 as it includes a bunch of critical bug fixes.
Fixed
- Fixed internal
constructFromthrowing an exception onnullarguments. Whilenullisn't allowed, the functions should rather returnInvalid DateorNaNin such cases. See #3885.
Added
- Added missing time zone support to
format,formatISO,formatISO9075,formatRelativeandformatRFC3339. See #3886.
v4.0.0
I have great news! First, ten years after its release, date-fns finally gets first-class time zone support.
Another great news is that there aren't many breaking changes in this release. All of them are type-related and will affect only those explicitly using internal date-fns types. Finally, it has been less than a year since the last major release, which is an improvement over the previous four years between v2 and v3. I plan on keeping the pace and minimizing breaking changes moving forward.
Read more about the release in the announcement blog post.
Added
-
Added time zones support via
@date-fns/tz'sTZDateclass andtzhelper function. See its README for the details about the API. -
All relevant functions now accept the context
inoption, which allows to specify the time zone to make the calculations in. If the function also returns a date, it will be in the specified time zone:import { addDays, startOfDay } from "date-fns"; import { tz } from "@​date-fns/tz"; startOfDay(addDays(Date.now(), 5, { in: tz("Asia/Singapore") })); //=> "2024-09-16T00:00:00.000+08:00"In the example,
addDayswill get the current date and time in Singapore and add 5 days to it.startOfDaywill inherit the date type and return the start of the day in Singapore.
Changed
-
The function arguments, as well as
Interval'sstartandend, now can be of different types, allowing you to mixUTCDate,TZDate,Date, and other extensions, as well as primitives (strings and numbers).The functions will normalize these values, make calculations, and return the result in the same type, preventing any bugs caused by the discrepancy. If passed, the type will be inferred from the context
inoption or the first encountered argument object type. TheInterval'sstartandendwill be considered separately, starting fromstart.In the given example, the result will be in the
TZDateas the first argument is a number, and thestarttakes precedence over theend.clamp(Date.now(), { start: new TZDate(start, "Asia/Singapore"), end: new UTCDate(), }); //=> TZDate -
BREAKING: This release contains a bunch of types changes that should not affect the library's expected usage. The changes are primarily internal and nuanced, so rather than listing them here, I recommend you running the type checker after the upgrade. If there are unfixable problems, please open an issue.
-
BREAKING: The package now is ESM-first. The CommonJS is still support and It should not affect most users, but it might break in certains environments. If you encounter any issues, please report them.
Fixed
- Fixed CDN build compatibility with jQuery and other tools that expose
$by properly wrapping the code in an IIFE.
v3.6.0
On this release worked @kossnocorp and @world1dan. Also, thanks to @seated for sponsoring me.
Fixed
Added
v3.5.0
Kudos to @fturmel, @kossnocorp, @makstyle119, @tan75, @marcreichel, @tareknatsheh and @audunru for working on the release. Also, thanks to @seated for sponsoring me.
Fixed
Added
-
Added the
constructNowfunction that creates the current date using the passed reference date's constructor.
v3.4.0
Kudos to @kossnocorp, @sakamossan and @Revan99 for working on the release. Also, thanks to @seated for sponsoring me.
Added
v3.3.1
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
truncinstead ofround. The bug was introduced in v3.3.0. The affected functions:differenceInCalendarDays,differenceInCalendarISOWeeks,differenceInCalendarWeeks,getISOWeek,getWeek, andgetISOWeeksInYear.
v3.3.0
On this release worked @kossnocorp, @TheKvikk, @fturmel and @ckcherry23.
Fixed
-
Fixed the bug in
getOverlappingDaysInIntervalscaused 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 ofMath.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,quartersToMonthsandmonthsToQuarters. -
Fixed the Czech locale's
formatDistanceto include1informatDistance. -
Fixed
differenceInSecondsand 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
yearsToDaysto the FP submodule. -
Made functions using rounding methods always return
0instead of-0.
Added
v3.2.0
This release is brought to you by @kossnocorp, @fturmel, @grossbart, @MelvinVermeer, and @jcarstairs-scottlogic.
Fixed
-
Fixed types compatibility with Lodash's
flowand fp-ts'spipe. (#3641)
Added
- Added exports of
format,lightFormat, andparseinternals that enable 3rd-parties to consume those.
v3.1.0
This release is brought to you by @kossnocorp, @makstyle119 and @dmgawel.
Fixed
Added
-
Added warning about using protected tokens like
YorDwithout passing a corresponding option. See #2950.
v3.0.6
On this release worked @imwh0im, @jamcry and @tyrw.
Fixed
v3.0.5
This release is brought to you by @goku4199.
Fixed
v3.0.4
This release is brought to you by @kossnocorp.
Fixed
- Fixed isWithinInterval bug caused by incorrectly sorting dates (#3623).
v3.0.3
Fixed
- Rolled back pointing ESM types to the same
d.tsfiles. Instead now it copies the content to avoid the Masquerading as CJS problem reported by "Are the types wrong?".
v3.0.2
Fixed
-
Fixed yet another issue caused by ESM types by pointing to the same
d.tsfiles. -
Added
package.jsonto exports to provide access to tooling. -
Fixed TypeScript 5.4 build break by using the latest type names.
v3.0.1
Fixed
-
Fixed an error in certain environments caused by
d.mtsfiles exporting only types.
v3.0.0
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.mjsextension. -
BREAKING: The package now has a flat structure, meaning functions are now named
node_modules/date-fns/add.mjs, locales arenode_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’)toconst { addDays } = require(‘date-fns/addDays’). -
BREAKING: TypeScript types are now completely rewritten, check out the
d.tsfiles for more information. -
BREAKING:
constantsnow is not exported via the index, so to import one useimport { 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
Intervalarguments 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 anInvalid Date, these functions also do not throw and handle them as invalid intervals.-
areIntervalsOverlappingnormalize intervals before comparison, so{ start: a, end: b }is practically equivalent to{ start: b, end: a }. When comparing intervals with one of the properties beingInvalid Date, the function will return false unless the others are valid and equal, given theinclusiveoption is passed. Otherwise, and when even one of the intervals has both properties invalid, the function will always returnfalse. -
getOverlappingDaysInIntervalsnow normalizes intervals before comparison, so{ start: a, end: b }is practically equivalent to{ start: b, end: a }. If any of the intervals’ properties is anInvalid Date, the function will always return 0. -
isWithinIntervalnow normalizes intervals before comparison, so{ start: a, end: b }is practically equivalent to{ start: b, end: a }. If any of the intervals’ properties is anInvalid Date, the function will always return false. -
intervalToDurationnow 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 thestepoption now also allow negative, 0, and NaN values and return reversed results if the step is negative and an empty array otherwise.
-
-
BREAKING:
intervalToDurationnow skips 0 values in the resulting duration, resulting in more compact objects with only relevant properties. -
BREAKING:
roundToNearestMinutesnow returnsInvalid Dateinstead of throwing an error whennearestTooption is less than 1 or more than 30. -
BREAKING: IE is no longer supported.
-
BREAKING: Now all functions use
Math.truncrounding method where rounding is required. The behavior is configurable on a per-function basis. -
BREAKING: Undocumented
onlyNumericoption was removed fromnnandsvlocales. 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, andeachYearOfIntervalnow accept thestepoption like most of the eachXOfInterval functions. -
A new
intervalfunction that validates interval, emulating the v2 interval functions behavior. -
differenceInXfunctions now accept options and allow setting uproundingMethodthat configures how the result is rounded.Math.truncis the default method.
v2.30.0
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
This release is prepared by our own @leshakoss.
Fixed
v2.29.2
This release is brought to you by @nopears, @vadimpopa and @leshakoss.
Fixed
v2.29.1
Thanks to @fturmel for working on the release.
Fixed
v2.29.0
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
-
Fixed long formatters in the South African English locale (
en-ZA). -
Fixed weekday format for
formatRelativein the Portuguese locale (pt). -
Fixed issue parsing months in Croatian (
hr), Georgian (ka) and Serbian (srandsr-Latn) locales.
Changed
v2.28.0
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
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
-
Fixed translation for quarters in
formatin Chinese Simplified locale (zh-CN). -
Fixed regular expressions for
parsein Estonian locale (er). -
Fixed the format of zeros in
formatDurationin Czech locale (cs). -
Fixed constants not having proper TypeScript and Flow types.
-
Fixed
eachMinuteOfIntervalnot handling intervals less than a minute correctly.
Added
v2.26.0
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
This release is brought to you by @kossnocorp, @gierschv, @fturmel, @redbmk, @mprovenc, @artyom-ivanov and @tan75.
Added
v2.24.0
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
-
Used
1instead ofeinfor GermanformatDurationto make it consistent with other locales and formats. (#2505) -
Made Norwegian
formatDurationconsistent with other locales by using numeric representation instead of written. (#2469) -
Use the word "sekunda" instead of "vteřina" for second in the Czech locale.
-
Made Flemish short date format corresponds to the Flemish government.
Added
-
Added
roundingMethodoption todifferenceInHours,differenceInMinutes,differenceInQuarters,differenceInSecondsanddifferenceInWeekswithtruncas the default method. (#2555)
v2.23.0
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
-
Added a new
clampfunction that allows to bound a date to an interval. -
Allowed passing
undefinedin the duration to add and sub functions.
v2.22.1
Thanks to Sasha Koss for working on the release.
Fixed
- Fixed constant typings. (#2491)
v2.22.0
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
This release is brought to you by Maxim Topciu.
Fixed
v2.21.2
Kudos to Aleksei Korzun, Maxim Topciu, Jonas L, Mohammad ali Ali panah and Tan75 for working on the release.
Fixed
v2.21.1
Thanks to Sasha Koss for working on the release.
Fixed
v2.21.0
This release is brought to you by Aleksei Korzun, Tan75, Rubens Mariuzzo, Christoph Stenglein and Clément Tamisier.
Fixed
Added
v2.20.3
Kudos to fturmel for working on the release.
Fixed
v2.20.2
Kudos to Maxim Topciu for working on the release.
Fixed
v2.20.1
This release is brought to you by Sasha Koss and Tan75.
Fixed
- Fixed
isDateFlow typings that we broke inv2.20.0.
v2.20.0
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
-
Made
formatDistanceStrictandformatDistanceToNowStrictalways return1 yearinstead of12 months. (#2388) -
Fixed
nextDay,nextMondayandnextTuesdaymissing in exports and type definitions. (#2325)
Added
v2.19.0
Tan75 worked on this release.
Fixed
-
Assigned the correct
firstWeekContainsDatevalue (4) for the French locale. (#2148) -
Fixed a bug in
differenceInMonthsandintervalToDurationthat occurs when dealing with the 28th of February. (#2255)
Added
v2.18.0
Thanks to Tan75 and Lesha Koss.
Fixed
Added
v2.17.0
Kudos to @shaykav, @davidgape89, @rikkalo, @tan75, @talgautb, @owenl131, @kylesezhi, @inigoiparragirre, @gius, @Endeauvirr and @frankyston.
Fixed
-
Fixed
differenceInMonthsfor edge cases, such as the end of February dates. -
Fixed
formatDurationweek translation inptandpt-BRlocales. -
Made Japanese locale to use the correct value for the start of the week.
-
Fixed the short and medium date formats in the Czech locale.
Added
-
Added
intlFormata lightweight formatting function that uses Intl API. Eventually, it will become the default formatting function, so it's highly recommended for new code. -
Added an ability to format lowercase am/pm with
aaaandbbbtokens.
v2.16.1
Kudos to @aleksaps, @leedriscoll and @BanForFun for pull-requests!
Fixed
- Fixed a typo in Scottish Gaelic (gd) locale.
- Fixed typos in Serbian Latin locale.
-
Fixed greek grammar for Saturday on
formatRelative. - Removed locale snapshots from the npm package making it lighter.
v2.16.0
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
-
Added correct translations for Welsh
1 minuteand2 days. -
Fixed
formatRFC3339formatting timezone offset with minutes. -
Added missing locale type definition for
formatDuration - Fixed Scottish Gaelic locale issues.
Changed
- Used shorter Hebrew alternative for "about".
- Improved string arguments warning after upgrading to v2.
Added
v2.15.0
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
-
Fixed behavior of
addBusinessDayswhen input date is a weekend day. -
Fixed
parseISOnot returningInvalid Dateon incorrect string when there are spaces in it. -
Fixed
esround-tripping dates with Wednesday. -
Fixed round-trip bug with
d/EEEEordering in tokens likePPPPP. - Fixed issues with parsing values in Japanese.
- Fixed Hungarian breaking IE11.
- Fixed Spanish accents in Saturday and Wednesday.
Changed
Added
-
Added Swiss-French
fr-CHlocale. -
Added Flemish
nl-BElocale. -
Added Scottish Gaelic
gdlocale. -
Added New Zealand English
en-NZlocale. -
Added
isMatchfunction.
v2.14.0
Kudos to @julamb, @JacobSoderblom, @justingrant, @dragunoff, @jmate0321, @gbhasha, @rasck, @AlbertoPdRF, @sebastianhaberey and [@giogonzo](http
Configuration
📅 Schedule: Branch creation - "on the 1st through 7th day of the month" in timezone America/Los_Angeles, Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
- [ ] If you want to rebase/retry this PR, check this box
This PR was generated by Mend Renovate. View the repository job log.