Update dependency date-fns to v4
This MR contains the following updates:
Package | Change | Age | Confidence |
---|---|---|---|
date-fns | ^3.3.0 -> ^4.0.0 |
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
constructFrom
throwing an exception onnull
arguments. Whilenull
isn't allowed, the functions should rather returnInvalid Date
orNaN
in such cases. See #3885.
Added
- Added missing time zone support to
format
,formatISO
,formatISO9075
,formatRelative
andformatRFC3339
. 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
'sTZDate
class andtz
helper function. See its README for the details about the API. -
All relevant functions now accept the context
in
option, 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,
addDays
will get the current date and time in Singapore and add 5 days to it.startOfDay
will inherit the date type and return the start of the day in Singapore.
Changed
-
The function arguments, as well as
Interval
'sstart
andend
, 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
in
option or the first encountered argument object type. TheInterval
'sstart
andend
will be considered separately, starting fromstart
.In the given example, the result will be in the
TZDate
as the first argument is a number, and thestart
takes 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
constructNow
function 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
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.