date-fns/date-fns (date-fns)
### [`v4.1.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v410---2024-09-17)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v4.0.0...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](https://redirect.github.com/date-fns/tz/blob/main/CHANGELOG.md#v102---2024-09-14).
##### Fixed
- Fixed internal `constructFrom` throwing an exception on `null` arguments. While `null` isn't allowed, the functions should rather return `Invalid Date` or `NaN` in such cases. See [#3885](https://redirect.github.com/date-fns/date-fns/issues/3885).
##### Added
- Added missing time zone support to `format`, `formatISO`, `formatISO9075`, `formatRelative` and `formatRFC3339`. See [#3886](https://redirect.github.com/date-fns/date-fns/issues/3886).
### [`v4.0.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v400---2024-09-16)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.6.0...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](https://blog.date-fns.org/v40-with-time-zone-support/).
\- [Sasha @kossnocorp](https://twitter.com/kossnocorp)
##### Added
- Added time zones support via [`@date-fns/tz`](https://redirect.github.com/date-fns/tz)'s `TZDate` class and `tz` helper function. See its [README](https://redirect.github.com/date-fns/tz) 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:
```ts
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`'s `start` and `end`, now can be of different types, allowing you to mix `UTCDate`, `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. The `Interval`'s `start` and `end` will be considered separately, starting from `start`.
In the given example, the result will be in the `TZDate` as the first argument is a number, and the `start` takes precedence over the `end`.
```ts
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](https://redirect.github.com/date-fns/date-fns/issues/new).
- **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](https://redirect.github.com/date-fns/date-fns/issues/new).
##### Fixed
- Fixed CDN build compatibility with jQuery and other tools that expose `$` by properly wrapping the code in an IIFE.
### [`v3.6.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v360---2024-03-18)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.5.0...v3.6.0)
On this release worked [@kossnocorp](https://redirect.github.com/kossnocorp) and [@world1dan](https://redirect.github.com/world1dan). Also, thanks to [@seated](https://redirect.github.com/seated) [for sponsoring me](https://redirect.github.com/sponsors/kossnocorp).
##### Fixed
- [Fixed weeks in the Belarisuan locale's `formatDistance`.](https://redirect.github.com/date-fns/date-fns/pull/3720)
##### Added
- [Added CDN versions of modules compatible with older browsers.](https://redirect.github.com/date-fns/date-fns/pull/3737) [See the CDN guide.](https://date-fns.org/docs/CDN)
### [`v3.5.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v350---2024-03-15)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.4.0...v3.5.0)
Kudos to [@fturmel](https://redirect.github.com/fturmel), [@kossnocorp](https://redirect.github.com/kossnocorp), [@makstyle119](https://redirect.github.com/makstyle119), [@tan75](https://redirect.github.com/tan75), [@marcreichel](https://redirect.github.com/marcreichel), [@tareknatsheh](https://redirect.github.com/tareknatsheh) and [@audunru](https://redirect.github.com/audunru) for working on the release. Also, thanks to [@seated](https://redirect.github.com/seated) [for sponsoring me](https://redirect.github.com/sponsors/kossnocorp).
##### Fixed
- [Fixed functions that use current date internally and made them work with date extensions like `UTCDate`.](https://redirect.github.com/date-fns/date-fns/issues/3730)
- [Fixed `daysToWeeks` returning negative 0.](https://redirect.github.com/date-fns/date-fns/commit/882ced61c692c7c4a79eaaec6eb07cb9c8c9195b)
- [Fixed German grammar for the "half a minute" string.](https://redirect.github.com/date-fns/date-fns/pull/3715)
##### Added
- Added the `constructNow` function that creates the current date using the passed reference date's constructor.
### [`v3.4.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v340---2024-03-11)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.3.1...v3.4.0)
Kudos to [@kossnocorp](https://redirect.github.com/kossnocorp), [@sakamossan](https://redirect.github.com/sakamossan) and [@Revan99](https://redirect.github.com/Revan99) for working on the release. Also thanks to [@seated](https://redirect.github.com/seated) for sponsoring me.
##### Added
- [Added `roundToNearestHours` function.](https://redirect.github.com/date-fns/date-fns/pull/2752)
- [Added Central Kurdish (`ckb`) locale.](https://redirect.github.com/date-fns/date-fns/pull/3421)
### [`v3.3.1`](https://redirect.github.com/date-fns/date-fns/releases/tag/v3.3.1)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.3.0...v3.3.1)
Kudos to [@kossnocorp](https://redirect.github.com/kossnocorp) and [@fturmel](https://redirect.github.com/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 of `round`. The bug was introduced in v3.3.0. The affected functions: `differenceInCalendarDays`, `differenceInCalendarISOWeeks`, `differenceInCalendarWeeks`, `getISOWeek`, `getWeek`, and `getISOWeeksInYear`.
### [`v3.3.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v330---2024-01-20)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.2.0...v3.3.0)
On this release worked [@kossnocorp](https://redirect.github.com/kossnocorp), [@TheKvikk](https://redirect.github.com/TheKvikk), [@fturmel](https://redirect.github.com/fturmel) and [@ckcherry23](https://redirect.github.com/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 of `Math.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` and `monthsToQuarters`.
- [Fixed the Czech locale's `formatDistance` to include `1` in `formatDistance`.](https://redirect.github.com/date-fns/date-fns/pull/3269)
- 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.](https://redirect.github.com/date-fns/date-fns/pull/3662) ([#1391](https://redirect.github.com/date-fns/date-fns/issues/1391))
- Added missing `yearsToDays` to the FP submodule.
- Made functions using rounding methods always return `0` instead of `-0`.
##### Added
- [Added `format` alias `formatDate` with corresponding `FormatDateOptions` interface](https://redirect.github.com/date-fns/date-fns/pull/3653).
### [`v3.2.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v320---2024-01-09)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.1.0...v3.2.0)
This release is brought to you by [@kossnocorp](https://redirect.github.com/kossnocorp), [@fturmel](https://redirect.github.com/fturmel), [@grossbart](https://redirect.github.com/grossbart), [@MelvinVermeer](https://redirect.github.com/MelvinVermeer), and [@jcarstairs-scottlogic](https://redirect.github.com/jcarstairs-scottlogic).
##### Fixed
- Fixed types compatability with Lodash's `flow` and fp-ts's `pipe`. ([#3641](https://redirect.github.com/date-fns/date-fns/issues/3641))
- [Fixed inconsistent behavior of `roundToNearestMinutes`.](https://redirect.github.com/date-fns/date-fns/pull/3132)
##### Added
- Added exports of `format`, `lightFormat`, and `parse` internals that enable 3rd-parties to consume those.
### [`v3.1.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v310---2024-01-05)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.6...v3.1.0)
This release is brought to you by [@kossnocorp](https://redirect.github.com/kossnocorp), [@makstyle119](https://redirect.github.com/makstyle119) and [@dmgawel](https://redirect.github.com/dmgawel).
##### Fixed
- [Fixed the plural form of weeks in Swedish](https://redirect.github.com/date-fns/date-fns/pull/3448).
##### Added
- [Added `yearsToDays` function](https://redirect.github.com/date-fns/date-fns/pull/3540).
- Added warning about using protected tokens like `Y` or `D` without passing a corresponding option. [See #2950](https://redirect.github.com/date-fns/date-fns/issues/2950).
### [`v3.0.6`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v306---2023-12-22)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.5...v3.0.6)
On this release worked [@imwh0im](https://redirect.github.com/imwh0im), [@jamcry](https://redirect.github.com/jamcry) and [@tyrw](https://redirect.github.com/tyrw).
##### Fixed
- [Fixed bug in `areIntervalsOverlapping` caused by incorrect sorting](https://redirect.github.com/date-fns/date-fns/pull/3628) ([#3614](https://redirect.github.com/date-fns/date-fns/issues/3614))
### [`v3.0.5`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v305---2023-12-21)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.4...v3.0.5)
This release is brought to you by [@goku4199](https://redirect.github.com/goku4199).
##### Fixed
- [Fixed internal `toDate` not processing string arguments properly](https://redirect.github.com/date-fns/date-fns/pull/3626)
### [`v3.0.4`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v304---2023-12-21)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.3...v3.0.4)
This release is brought to you by [@kossnocorp](https://redirect.github.com/kossnocorp).
##### Fixed
- Fixed isWithinInterval bug caused by incorrectly sorting dates ([#3623](https://redirect.github.com/date-fns/date-fns/issues/3623)).
### [`v3.0.3`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v303---2023-12-21)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.2...v3.0.3)
##### Fixed
- Rolled back pointing ESM types to the same `d.ts` files. Instead now it copies the content to avoid [the Masquerading as CJS problem](https://redirect.github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md) reported by "Are the types wrong?".
### [`v3.0.2`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v302---2023-12-21)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.1...v3.0.2)
##### Fixed
- Fixed [yet another issue caused by ESM types](https://redirect.github.com/date-fns/date-fns/issues/3620) by pointing to the same `d.ts` files.
- [Added `package.json` to exports](https://redirect.github.com/date-fns/date-fns/pull/3601) to provide access to tooling.
- [Fixed TypeScript 5.4 build break](https://redirect.github.com/date-fns/date-fns/pull/3598) by using the latest type names.
### [`v3.0.1`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v301---2023-12-20)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.0...v3.0.1)
##### Fixed
- [Fixed an error](https://redirect.github.com/date-fns/date-fns/pull/3618) in certain environments caused by `d.mts` files exporting only types.
### [`v3.0.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v300---2023-12-18)
[Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v2.30.0...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 `.mjs` extension.
- **BREAKING**: The package now has a flat structure, meaning functions are now named `node_modules/date-fns/add.mjs`, locales are `node_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’)` to `const { 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 use `import { daysInYear } from "date-fns/constants";`. It improves compatibility with setups that modularize imports [like Next.js](https://twitter.com/kossnocorp/status/1731181274579325260).
- **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 an `Invalid 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 being `Invalid Date`, the function will return false unless the others are valid and equal, given the `inclusive` option is passed. Otherwise, and when even one of the intervals has both properties invalid, the function will always return `false`.
- `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 an `Invalid 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 an `Invalid 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 the `step` 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 returns `Invalid Date` instead of throwing an error when `nearestTo` 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 from `nn` and `sv` locales. If you relied on it, [please contact me](mailto:koss@nocorp.me).
- **BREAKING**: Flow is not supported anymore. If you relied on it, [please contact me](mailto:koss@nocorp.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](https://redirect.github.com/date-fns/utc). They will detect and use the arguments constructor to generate the result of the same class.
- `eachMonthOfInterval`, `eachQuarterOfInterval`, `eachWeekOfInterval`, and `eachYearOfInterval` now accept the `step` 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 up `roundingMethod` that configures how the result is rounded. `Math.trunc` is the default method.
Configuration
📅 Schedule: Branch creation - "every weekday" (UTC), 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 contains the following updates:
^2.28.0->^4.0.0Release Notes
date-fns/date-fns (date-fns)
### [`v4.1.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v410---2024-09-17) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v4.0.0...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](https://redirect.github.com/date-fns/tz/blob/main/CHANGELOG.md#v102---2024-09-14). ##### Fixed - Fixed internal `constructFrom` throwing an exception on `null` arguments. While `null` isn't allowed, the functions should rather return `Invalid Date` or `NaN` in such cases. See [#3885](https://redirect.github.com/date-fns/date-fns/issues/3885). ##### Added - Added missing time zone support to `format`, `formatISO`, `formatISO9075`, `formatRelative` and `formatRFC3339`. See [#3886](https://redirect.github.com/date-fns/date-fns/issues/3886). ### [`v4.0.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v400---2024-09-16) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.6.0...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](https://blog.date-fns.org/v40-with-time-zone-support/). \- [Sasha @kossnocorp](https://twitter.com/kossnocorp) ##### Added - Added time zones support via [`@date-fns/tz`](https://redirect.github.com/date-fns/tz)'s `TZDate` class and `tz` helper function. See its [README](https://redirect.github.com/date-fns/tz) 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: ```ts 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`'s `start` and `end`, now can be of different types, allowing you to mix `UTCDate`, `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. The `Interval`'s `start` and `end` will be considered separately, starting from `start`. In the given example, the result will be in the `TZDate` as the first argument is a number, and the `start` takes precedence over the `end`. ```ts 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](https://redirect.github.com/date-fns/date-fns/issues/new). - **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](https://redirect.github.com/date-fns/date-fns/issues/new). ##### Fixed - Fixed CDN build compatibility with jQuery and other tools that expose `$` by properly wrapping the code in an IIFE. ### [`v3.6.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v360---2024-03-18) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.5.0...v3.6.0) On this release worked [@kossnocorp](https://redirect.github.com/kossnocorp) and [@world1dan](https://redirect.github.com/world1dan). Also, thanks to [@seated](https://redirect.github.com/seated) [for sponsoring me](https://redirect.github.com/sponsors/kossnocorp). ##### Fixed - [Fixed weeks in the Belarisuan locale's `formatDistance`.](https://redirect.github.com/date-fns/date-fns/pull/3720) ##### Added - [Added CDN versions of modules compatible with older browsers.](https://redirect.github.com/date-fns/date-fns/pull/3737) [See the CDN guide.](https://date-fns.org/docs/CDN) ### [`v3.5.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v350---2024-03-15) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.4.0...v3.5.0) Kudos to [@fturmel](https://redirect.github.com/fturmel), [@kossnocorp](https://redirect.github.com/kossnocorp), [@makstyle119](https://redirect.github.com/makstyle119), [@tan75](https://redirect.github.com/tan75), [@marcreichel](https://redirect.github.com/marcreichel), [@tareknatsheh](https://redirect.github.com/tareknatsheh) and [@audunru](https://redirect.github.com/audunru) for working on the release. Also, thanks to [@seated](https://redirect.github.com/seated) [for sponsoring me](https://redirect.github.com/sponsors/kossnocorp). ##### Fixed - [Fixed functions that use current date internally and made them work with date extensions like `UTCDate`.](https://redirect.github.com/date-fns/date-fns/issues/3730) - [Fixed `daysToWeeks` returning negative 0.](https://redirect.github.com/date-fns/date-fns/commit/882ced61c692c7c4a79eaaec6eb07cb9c8c9195b) - [Fixed German grammar for the "half a minute" string.](https://redirect.github.com/date-fns/date-fns/pull/3715) ##### Added - Added the `constructNow` function that creates the current date using the passed reference date's constructor. ### [`v3.4.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v340---2024-03-11) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.3.1...v3.4.0) Kudos to [@kossnocorp](https://redirect.github.com/kossnocorp), [@sakamossan](https://redirect.github.com/sakamossan) and [@Revan99](https://redirect.github.com/Revan99) for working on the release. Also thanks to [@seated](https://redirect.github.com/seated) for sponsoring me. ##### Added - [Added `roundToNearestHours` function.](https://redirect.github.com/date-fns/date-fns/pull/2752) - [Added Central Kurdish (`ckb`) locale.](https://redirect.github.com/date-fns/date-fns/pull/3421) ### [`v3.3.1`](https://redirect.github.com/date-fns/date-fns/releases/tag/v3.3.1) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.3.0...v3.3.1) Kudos to [@kossnocorp](https://redirect.github.com/kossnocorp) and [@fturmel](https://redirect.github.com/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 of `round`. The bug was introduced in v3.3.0. The affected functions: `differenceInCalendarDays`, `differenceInCalendarISOWeeks`, `differenceInCalendarWeeks`, `getISOWeek`, `getWeek`, and `getISOWeeksInYear`. ### [`v3.3.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v330---2024-01-20) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.2.0...v3.3.0) On this release worked [@kossnocorp](https://redirect.github.com/kossnocorp), [@TheKvikk](https://redirect.github.com/TheKvikk), [@fturmel](https://redirect.github.com/fturmel) and [@ckcherry23](https://redirect.github.com/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 of `Math.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` and `monthsToQuarters`. - [Fixed the Czech locale's `formatDistance` to include `1` in `formatDistance`.](https://redirect.github.com/date-fns/date-fns/pull/3269) - 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.](https://redirect.github.com/date-fns/date-fns/pull/3662) ([#1391](https://redirect.github.com/date-fns/date-fns/issues/1391)) - Added missing `yearsToDays` to the FP submodule. - Made functions using rounding methods always return `0` instead of `-0`. ##### Added - [Added `format` alias `formatDate` with corresponding `FormatDateOptions` interface](https://redirect.github.com/date-fns/date-fns/pull/3653). ### [`v3.2.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v320---2024-01-09) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.1.0...v3.2.0) This release is brought to you by [@kossnocorp](https://redirect.github.com/kossnocorp), [@fturmel](https://redirect.github.com/fturmel), [@grossbart](https://redirect.github.com/grossbart), [@MelvinVermeer](https://redirect.github.com/MelvinVermeer), and [@jcarstairs-scottlogic](https://redirect.github.com/jcarstairs-scottlogic). ##### Fixed - Fixed types compatability with Lodash's `flow` and fp-ts's `pipe`. ([#3641](https://redirect.github.com/date-fns/date-fns/issues/3641)) - [Fixed inconsistent behavior of `roundToNearestMinutes`.](https://redirect.github.com/date-fns/date-fns/pull/3132) ##### Added - Added exports of `format`, `lightFormat`, and `parse` internals that enable 3rd-parties to consume those. ### [`v3.1.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v310---2024-01-05) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.6...v3.1.0) This release is brought to you by [@kossnocorp](https://redirect.github.com/kossnocorp), [@makstyle119](https://redirect.github.com/makstyle119) and [@dmgawel](https://redirect.github.com/dmgawel). ##### Fixed - [Fixed the plural form of weeks in Swedish](https://redirect.github.com/date-fns/date-fns/pull/3448). ##### Added - [Added `yearsToDays` function](https://redirect.github.com/date-fns/date-fns/pull/3540). - Added warning about using protected tokens like `Y` or `D` without passing a corresponding option. [See #2950](https://redirect.github.com/date-fns/date-fns/issues/2950). ### [`v3.0.6`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v306---2023-12-22) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.5...v3.0.6) On this release worked [@imwh0im](https://redirect.github.com/imwh0im), [@jamcry](https://redirect.github.com/jamcry) and [@tyrw](https://redirect.github.com/tyrw). ##### Fixed - [Fixed bug in `areIntervalsOverlapping` caused by incorrect sorting](https://redirect.github.com/date-fns/date-fns/pull/3628) ([#3614](https://redirect.github.com/date-fns/date-fns/issues/3614)) ### [`v3.0.5`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v305---2023-12-21) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.4...v3.0.5) This release is brought to you by [@goku4199](https://redirect.github.com/goku4199). ##### Fixed - [Fixed internal `toDate` not processing string arguments properly](https://redirect.github.com/date-fns/date-fns/pull/3626) ### [`v3.0.4`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v304---2023-12-21) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.3...v3.0.4) This release is brought to you by [@kossnocorp](https://redirect.github.com/kossnocorp). ##### Fixed - Fixed isWithinInterval bug caused by incorrectly sorting dates ([#3623](https://redirect.github.com/date-fns/date-fns/issues/3623)). ### [`v3.0.3`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v303---2023-12-21) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.2...v3.0.3) ##### Fixed - Rolled back pointing ESM types to the same `d.ts` files. Instead now it copies the content to avoid [the Masquerading as CJS problem](https://redirect.github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md) reported by "Are the types wrong?". ### [`v3.0.2`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v302---2023-12-21) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.1...v3.0.2) ##### Fixed - Fixed [yet another issue caused by ESM types](https://redirect.github.com/date-fns/date-fns/issues/3620) by pointing to the same `d.ts` files. - [Added `package.json` to exports](https://redirect.github.com/date-fns/date-fns/pull/3601) to provide access to tooling. - [Fixed TypeScript 5.4 build break](https://redirect.github.com/date-fns/date-fns/pull/3598) by using the latest type names. ### [`v3.0.1`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v301---2023-12-20) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v3.0.0...v3.0.1) ##### Fixed - [Fixed an error](https://redirect.github.com/date-fns/date-fns/pull/3618) in certain environments caused by `d.mts` files exporting only types. ### [`v3.0.0`](https://redirect.github.com/date-fns/date-fns/blob/HEAD/CHANGELOG.md#v300---2023-12-18) [Compare Source](https://redirect.github.com/date-fns/date-fns/compare/v2.30.0...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 `.mjs` extension. - **BREAKING**: The package now has a flat structure, meaning functions are now named `node_modules/date-fns/add.mjs`, locales are `node_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’)` to `const { 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 use `import { daysInYear } from "date-fns/constants";`. It improves compatibility with setups that modularize imports [like Next.js](https://twitter.com/kossnocorp/status/1731181274579325260). - **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 an `Invalid 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 being `Invalid Date`, the function will return false unless the others are valid and equal, given the `inclusive` option is passed. Otherwise, and when even one of the intervals has both properties invalid, the function will always return `false`. - `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 an `Invalid 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 an `Invalid 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 the `step` 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 returns `Invalid Date` instead of throwing an error when `nearestTo` 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 from `nn` and `sv` locales. If you relied on it, [please contact me](mailto:koss@nocorp.me). - **BREAKING**: Flow is not supported anymore. If you relied on it, [please contact me](mailto:koss@nocorp.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](https://redirect.github.com/date-fns/utc). They will detect and use the arguments constructor to generate the result of the same class. - `eachMonthOfInterval`, `eachQuarterOfInterval`, `eachWeekOfInterval`, and `eachYearOfInterval` now accept the `step` 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 up `roundingMethod` that configures how the result is rounded. `Math.trunc` is the default method.Configuration
📅 Schedule: Branch creation - "every weekday" (UTC), 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.
This PR was generated by Mend Renovate. View the repository job log.