differenceInHours.js 1.2 KB

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