differenceInCalendarQuarters.js 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. import { normalizeDates } from "./_lib/normalizeDates.js";
  2. import { getQuarter } from "./getQuarter.js";
  3. /**
  4. * The {@link differenceInCalendarQuarters} function options.
  5. */
  6. /**
  7. * @name differenceInCalendarQuarters
  8. * @category Quarter Helpers
  9. * @summary Get the number of calendar quarters between the given dates.
  10. *
  11. * @description
  12. * Get the number of calendar quarters between the given dates.
  13. *
  14. * @param laterDate - The later date
  15. * @param earlierDate - The earlier date
  16. * @param options - An object with options
  17. *
  18. * @returns The number of calendar quarters
  19. *
  20. * @example
  21. * // How many calendar quarters are between 31 December 2013 and 2 July 2014?
  22. * const result = differenceInCalendarQuarters(
  23. * new Date(2014, 6, 2),
  24. * new Date(2013, 11, 31)
  25. * )
  26. * //=> 3
  27. */
  28. export function differenceInCalendarQuarters(laterDate, earlierDate, options) {
  29. const [laterDate_, earlierDate_] = normalizeDates(
  30. options?.in,
  31. laterDate,
  32. earlierDate,
  33. );
  34. const yearsDiff = laterDate_.getFullYear() - earlierDate_.getFullYear();
  35. const quartersDiff = getQuarter(laterDate_) - getQuarter(earlierDate_);
  36. return yearsDiff * 4 + quartersDiff;
  37. }
  38. // Fallback for modularized imports:
  39. export default differenceInCalendarQuarters;