index.js 1.1 KB

1234567891011121314151617181920212223242526272829
  1. import getISOWeekYear from "../getISOWeekYear/index.js";
  2. import requiredArgs from "../_lib/requiredArgs/index.js";
  3. /**
  4. * @name differenceInCalendarISOWeekYears
  5. * @category ISO Week-Numbering Year Helpers
  6. * @summary Get the number of calendar ISO week-numbering years between the given dates.
  7. *
  8. * @description
  9. * Get the number of calendar ISO week-numbering years between the given dates.
  10. *
  11. * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  12. *
  13. * @param {Date|Number} dateLeft - the later date
  14. * @param {Date|Number} dateRight - the earlier date
  15. * @returns {Number} the number of calendar ISO week-numbering years
  16. * @throws {TypeError} 2 arguments required
  17. *
  18. * @example
  19. * // How many calendar ISO week-numbering years are 1 January 2010 and 1 January 2012?
  20. * const result = differenceInCalendarISOWeekYears(
  21. * new Date(2012, 0, 1),
  22. * new Date(2010, 0, 1)
  23. * )
  24. * //=> 2
  25. */
  26. export default function differenceInCalendarISOWeekYears(dirtyDateLeft, dirtyDateRight) {
  27. requiredArgs(2, arguments);
  28. return getISOWeekYear(dirtyDateLeft) - getISOWeekYear(dirtyDateRight);
  29. }