index.js 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. import toDate from "../toDate/index.js";
  2. import differenceInCalendarISOWeekYears from "../differenceInCalendarISOWeekYears/index.js";
  3. import compareAsc from "../compareAsc/index.js";
  4. import subISOWeekYears from "../subISOWeekYears/index.js";
  5. import requiredArgs from "../_lib/requiredArgs/index.js";
  6. /**
  7. * @name differenceInISOWeekYears
  8. * @category ISO Week-Numbering Year Helpers
  9. * @summary Get the number of full ISO week-numbering years between the given dates.
  10. *
  11. * @description
  12. * Get the number of full ISO week-numbering years between the given dates.
  13. *
  14. * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  15. *
  16. * @param {Date|Number} dateLeft - the later date
  17. * @param {Date|Number} dateRight - the earlier date
  18. * @returns {Number} the number of full ISO week-numbering years
  19. * @throws {TypeError} 2 arguments required
  20. *
  21. * @example
  22. * // How many full ISO week-numbering years are between 1 January 2010 and 1 January 2012?
  23. * const result = differenceInISOWeekYears(
  24. * new Date(2012, 0, 1),
  25. * new Date(2010, 0, 1)
  26. * )
  27. * //=> 1
  28. */
  29. export default function differenceInISOWeekYears(dirtyDateLeft, dirtyDateRight) {
  30. requiredArgs(2, arguments);
  31. var dateLeft = toDate(dirtyDateLeft);
  32. var dateRight = toDate(dirtyDateRight);
  33. var sign = compareAsc(dateLeft, dateRight);
  34. var difference = Math.abs(differenceInCalendarISOWeekYears(dateLeft, dateRight));
  35. dateLeft = subISOWeekYears(dateLeft, sign * difference);
  36. // Math.abs(diff in full ISO years - diff in calendar ISO years) === 1
  37. // if last calendar ISO year is not full
  38. // If so, result must be decreased by 1 in absolute value
  39. var isLastISOWeekYearNotFull = Number(compareAsc(dateLeft, dateRight) === -sign);
  40. var result = sign * (difference - isLastISOWeekYearNotFull);
  41. // Prevent negative zero
  42. return result === 0 ? 0 : result;
  43. }