differenceInCalendarQuarters.mjs 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. import { getQuarter } from "./getQuarter.mjs";
  2. import { toDate } from "./toDate.mjs";
  3. /**
  4. * @name differenceInCalendarQuarters
  5. * @category Quarter Helpers
  6. * @summary Get the number of calendar quarters between the given dates.
  7. *
  8. * @description
  9. * Get the number of calendar quarters between the given dates.
  10. *
  11. * @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).
  12. *
  13. * @param dateLeft - The later date
  14. * @param dateRight - The earlier date
  15. * @returns The number of calendar quarters
  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 function differenceInCalendarQuarters(dateLeft, dateRight) {
  26. const _dateLeft = toDate(dateLeft);
  27. const _dateRight = toDate(dateRight);
  28. const yearDiff = _dateLeft.getFullYear() - _dateRight.getFullYear();
  29. const quarterDiff = getQuarter(_dateLeft) - getQuarter(_dateRight);
  30. return yearDiff * 4 + quarterDiff;
  31. }
  32. // Fallback for modularized imports:
  33. export default differenceInCalendarQuarters;