differenceInCalendarISOWeekYears.mjs 1.2 KB

123456789101112131415161718192021222324252627282930313233
  1. import { getISOWeekYear } from "./getISOWeekYear.mjs";
  2. /**
  3. * @name differenceInCalendarISOWeekYears
  4. * @category ISO Week-Numbering Year Helpers
  5. * @summary Get the number of calendar ISO week-numbering years between the given dates.
  6. *
  7. * @description
  8. * Get the number of calendar ISO week-numbering years between the given dates.
  9. *
  10. * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  11. *
  12. * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
  13. *
  14. * @param dateLeft - The later date
  15. * @param dateRight - The earlier date
  16. *
  17. * @returns The number of calendar ISO week-numbering years
  18. *
  19. * @example
  20. * // How many calendar ISO week-numbering years are 1 January 2010 and 1 January 2012?
  21. * const result = differenceInCalendarISOWeekYears(
  22. * new Date(2012, 0, 1),
  23. * new Date(2010, 0, 1)
  24. * )
  25. * //=> 2
  26. */
  27. export function differenceInCalendarISOWeekYears(dateLeft, dateRight) {
  28. return getISOWeekYear(dateLeft) - getISOWeekYear(dateRight);
  29. }
  30. // Fallback for modularized imports:
  31. export default differenceInCalendarISOWeekYears;