differenceInQuarters.js 1.0 KB

123456789101112131415161718192021222324252627282930313233
  1. import { getRoundingMethod } from "./_lib/getRoundingMethod.js";
  2. import { differenceInMonths } from "./differenceInMonths.js";
  3. /**
  4. * The {@link differenceInQuarters} function options.
  5. */
  6. /**
  7. * @name differenceInQuarters
  8. * @category Quarter Helpers
  9. * @summary Get the number of quarters between the given dates.
  10. *
  11. * @description
  12. * Get the number of 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 full quarters
  19. *
  20. * @example
  21. * // How many full quarters are between 31 December 2013 and 2 July 2014?
  22. * const result = differenceInQuarters(new Date(2014, 6, 2), new Date(2013, 11, 31))
  23. * //=> 2
  24. */
  25. export function differenceInQuarters(laterDate, earlierDate, options) {
  26. const diff = differenceInMonths(laterDate, earlierDate, options) / 3;
  27. return getRoundingMethod(options?.roundingMethod)(diff);
  28. }
  29. // Fallback for modularized imports:
  30. export default differenceInQuarters;