index.js 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. import { millisecondsInMinute } from "../constants/index.js";
  2. import differenceInMilliseconds from "../differenceInMilliseconds/index.js";
  3. import requiredArgs from "../_lib/requiredArgs/index.js";
  4. import { getRoundingMethod } from "../_lib/roundingMethods/index.js";
  5. /**
  6. * @name differenceInMinutes
  7. * @category Minute Helpers
  8. * @summary Get the number of minutes between the given dates.
  9. *
  10. * @description
  11. * Get the signed number of full (rounded towards 0) minutes between the given dates.
  12. *
  13. * @param {Date|Number} dateLeft - the later date
  14. * @param {Date|Number} dateRight - the earlier date
  15. * @param {Object} [options] - an object with options.
  16. * @param {String} [options.roundingMethod='trunc'] - a rounding method (`ceil`, `floor`, `round` or `trunc`)
  17. * @returns {Number} the number of minutes
  18. * @throws {TypeError} 2 arguments required
  19. *
  20. * @example
  21. * // How many minutes are between 2 July 2014 12:07:59 and 2 July 2014 12:20:00?
  22. * const result = differenceInMinutes(
  23. * new Date(2014, 6, 2, 12, 20, 0),
  24. * new Date(2014, 6, 2, 12, 7, 59)
  25. * )
  26. * //=> 12
  27. *
  28. * @example
  29. * // How many minutes are between 10:01:59 and 10:00:00
  30. * const result = differenceInMinutes(
  31. * new Date(2000, 0, 1, 10, 0, 0),
  32. * new Date(2000, 0, 1, 10, 1, 59)
  33. * )
  34. * //=> -1
  35. */
  36. export default function differenceInMinutes(dateLeft, dateRight, options) {
  37. requiredArgs(2, arguments);
  38. var diff = differenceInMilliseconds(dateLeft, dateRight) / millisecondsInMinute;
  39. return getRoundingMethod(options === null || options === void 0 ? void 0 : options.roundingMethod)(diff);
  40. }