Bump date-fns from 3.6.0 to 4.1.0
Bumps date-fns from 3.6.0 to 4.1.0.
Release notes
Sourced from date-fns's releases.
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(),
... (truncated)
Changelog
Sourced from date-fns's changelog.
v4.1.0 - 2024-09-17
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 - 2024-09-16
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(), {
... (truncated)
Commits
-
313b902
Fix v4.1.0 change log entry -
26cd336
Promote to v4.1.0 -
97b53b9
Cover time zone edge cases -
59b7563
Add missing time zone support to format, formatISO, formatISO9075, formatRela... -
0121164
Prevent constructFrom from throwing an error on null -
bd87ef5
Update@date-fns/docs
-
99b4e67
Prepare v4.0 -
8df1706
Rewrite the time zones doc -
e351977
Promote to v4.0.0-beta.1 -
8523656
Fix scripts/test/types.sh - Additional commits viewable in compare view