index.js 1.1 KB

1234567891011121314151617181920212223242526272829303132
  1. import getQuarter from "../getQuarter/index.js";
  2. import toDate from "../toDate/index.js";
  3. import requiredArgs from "../_lib/requiredArgs/index.js";
  4. /**
  5. * @name differenceInCalendarQuarters
  6. * @category Quarter Helpers
  7. * @summary Get the number of calendar quarters between the given dates.
  8. *
  9. * @description
  10. * Get the number of calendar quarters between the given dates.
  11. *
  12. * @param {Date|Number} dateLeft - the later date
  13. * @param {Date|Number} dateRight - the earlier date
  14. * @returns {Number} the number of calendar quarters
  15. * @throws {TypeError} 2 arguments required
  16. *
  17. * @example
  18. * // How many calendar quarters are between 31 December 2013 and 2 July 2014?
  19. * const result = differenceInCalendarQuarters(
  20. * new Date(2014, 6, 2),
  21. * new Date(2013, 11, 31)
  22. * )
  23. * //=> 3
  24. */
  25. export default function differenceInCalendarQuarters(dirtyDateLeft, dirtyDateRight) {
  26. requiredArgs(2, arguments);
  27. var dateLeft = toDate(dirtyDateLeft);
  28. var dateRight = toDate(dirtyDateRight);
  29. var yearDiff = dateLeft.getFullYear() - dateRight.getFullYear();
  30. var quarterDiff = getQuarter(dateLeft) - getQuarter(dateRight);
  31. return yearDiff * 4 + quarterDiff;
  32. }