fix(deps): update dependency date-fns to v4 #6744
Open
+9
−10
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^2.29.3
->^4.0.0
Release Notes
date-fns/date-fns (date-fns)
v4.1.0
Compare Source
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
constructFrom
throwing an exception onnull
arguments. Whilenull
isn't allowed, the functions should rather returnInvalid Date
orNaN
in such cases. See #3885.Added
format
,formatISO
,formatISO9075
,formatRelative
andformatRFC3339
. See #3886.v4.0.0
Compare Source
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.
- Sasha @kossnocorp
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: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
.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
$
by properly wrapping the code in an IIFE.v3.6.0
Compare Source
On this release worked @kossnocorp and @world1dan. Also, thanks to @seated for sponsoring me.
Fixed
formatDistance
.Added
v3.5.0
Compare Source
Kudos to @fturmel, @kossnocorp, @makstyle119, @tan75, @marcreichel, @tareknatsheh and @audunru for working on the release. Also, thanks to @seated for sponsoring me.
Fixed
Fixed functions that use current date internally and made them work with date extensions like
UTCDate
.Fixed
daysToWeeks
returning negative 0.Fixed German grammar for the "half a minute" string.
Added
constructNow
function that creates the current date using the passed reference date's constructor.v3.4.0
Compare Source
Kudos to @kossnocorp, @sakamossan and @Revan99 for working on the release. Also thanks to @seated for sponsoring me.
Added
Added
roundToNearestHours
function.Added Central Kurdish (
ckb
) locale.v3.3.1
Compare Source
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
trunc
instead ofround
. The bug was introduced in v3.3.0. The affected functions:differenceInCalendarDays
,differenceInCalendarISOWeeks
,differenceInCalendarWeeks
,getISOWeek
,getWeek
, andgetISOWeeksInYear
.v3.3.0
Compare Source
On this release worked @kossnocorp, @TheKvikk, @fturmel and @ckcherry23.
Fixed
Fixed the bug in
getOverlappingDaysInIntervals
caused 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
,quartersToMonths
andmonthsToQuarters
.Fixed the Czech locale's
formatDistance
to include1
informatDistance
.Fixed
differenceInSeconds
and 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
yearsToDays
to the FP submodule.Made functions using rounding methods always return
0
instead of-0
.Added
format
aliasformatDate
with correspondingFormatDateOptions
interface.v3.2.0
Compare Source
This release is brought to you by @kossnocorp, @fturmel, @grossbart, @MelvinVermeer, and @jcarstairs-scottlogic.
Fixed
Fixed types compatability with Lodash's
flow
and fp-ts'spipe
. (#3641)Fixed inconsistent behavior of
roundToNearestMinutes
.Added
format
,lightFormat
, andparse
internals that enable 3rd-parties to consume those.v3.1.0
Compare Source
This release is brought to you by @kossnocorp, @makstyle119 and @dmgawel.
Fixed
Added
Added
yearsToDays
function.Added warning about using protected tokens like
Y
orD
without passing a corresponding option. See #2950.v3.0.6
Compare Source
On this release worked @imwh0im, @jamcry and @tyrw.
Fixed
areIntervalsOverlapping
caused by incorrect sorting (#3614)v3.0.5
Compare Source
This release is brought to you by @goku4199.
Fixed
toDate
not processing string arguments properlyv3.0.4
Compare Source
This release is brought to you by @kossnocorp.
Fixed
v3.0.3
Compare Source
Fixed
d.ts
files. Instead now it copies the content to avoid the Masquerading as CJS problem reported by "Are the types wrong?".v3.0.2
Compare Source
Fixed
Fixed yet another issue caused by ESM types by pointing to the same
d.ts
files.Added
package.json
to exports to provide access to tooling.Fixed TypeScript 5.4 build break by using the latest type names.
v3.0.1
Compare Source
Fixed
d.mts
files exporting only types.v3.0.0
Compare Source
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.mjs
extension.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.ts
files for more information.BREAKING:
constants
now 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
Interval
arguments 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.areIntervalsOverlapping
normalize 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 theinclusive
option is passed. Otherwise, and when even one of the intervals has both properties invalid, the function will always returnfalse
.getOverlappingDaysInIntervals
now 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.isWithinInterval
now 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.intervalToDuration
now 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 thestep
option now also allow negative, 0, and NaN values and return reversed results if the step is negative and an empty array otherwise.BREAKING:
intervalToDuration
now skips 0 values in the resulting duration, resulting in more compact objects with only relevant properties.BREAKING:
roundToNearestMinutes
now returnsInvalid Date
instead of throwing an error whennearestTo
option is less than 1 or more than 30.BREAKING: IE is no longer supported.
BREAKING: Now all functions use
Math.trunc
rounding method where rounding is required. The behavior is configurable on a per-function basis.BREAKING: Undocumented
onlyNumeric
option was removed fromnn
andsv
locales. 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
, andeachYearOfInterval
now accept thestep
option like most of the eachXOfInterval functions.A new
interval
function that validates interval, emulating the v2 interval functions behavior.differenceInX
functions now accept options and allow setting uproundingMethod
that configures how the result is rounded.Math.trunc
is the default method.v2.30.0
Compare Source
Kudos to @kossnocorp and @Andarist for working on the release.
Changes
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), 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 these updates again.
This PR was generated by Mend Renovate. View the repository job log.