differenceInISOWeekYears.js 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. import { normalizeDates } from "./_lib/normalizeDates.js";
  2. import { compareAsc } from "./compareAsc.js";
  3. import { differenceInCalendarISOWeekYears } from "./differenceInCalendarISOWeekYears.js";
  4. import { subISOWeekYears } from "./subISOWeekYears.js";
  5. /**
  6. * The {@link differenceInISOWeekYears} function options.
  7. */
  8. /**
  9. * @name differenceInISOWeekYears
  10. * @category ISO Week-Numbering Year Helpers
  11. * @summary Get the number of full ISO week-numbering years between the given dates.
  12. *
  13. * @description
  14. * Get the number of full ISO week-numbering years between the given dates.
  15. *
  16. * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  17. *
  18. * @param laterDate - The later date
  19. * @param earlierDate - The earlier date
  20. * @param options - The options
  21. *
  22. * @returns The number of full ISO week-numbering years
  23. *
  24. * @example
  25. * // How many full ISO week-numbering years are between 1 January 2010 and 1 January 2012?
  26. * const result = differenceInISOWeekYears(
  27. * new Date(2012, 0, 1),
  28. * new Date(2010, 0, 1)
  29. * )
  30. * // => 1
  31. */
  32. export function differenceInISOWeekYears(laterDate, earlierDate, options) {
  33. const [laterDate_, earlierDate_] = normalizeDates(
  34. options?.in,
  35. laterDate,
  36. earlierDate,
  37. );
  38. const sign = compareAsc(laterDate_, earlierDate_);
  39. const diff = Math.abs(
  40. differenceInCalendarISOWeekYears(laterDate_, earlierDate_, options),
  41. );
  42. const adjustedDate = subISOWeekYears(laterDate_, sign * diff, options);
  43. const isLastISOWeekYearNotFull = Number(
  44. compareAsc(adjustedDate, earlierDate_) === -sign,
  45. );
  46. const result = sign * (diff - isLastISOWeekYearNotFull);
  47. // Prevent negative zero
  48. return result === 0 ? 0 : result;
  49. }
  50. // Fallback for modularized imports:
  51. export default differenceInISOWeekYears;