index.js 953 B

12345678910111213141516171819202122232425262728
  1. import toDate from "../toDate/index.js";
  2. import requiredArgs from "../_lib/requiredArgs/index.js";
  3. /**
  4. * @name differenceInMilliseconds
  5. * @category Millisecond Helpers
  6. * @summary Get the number of milliseconds between the given dates.
  7. *
  8. * @description
  9. * Get the number of milliseconds between the given dates.
  10. *
  11. * @param {Date|Number} dateLeft - the later date
  12. * @param {Date|Number} dateRight - the earlier date
  13. * @returns {Number} the number of milliseconds
  14. * @throws {TypeError} 2 arguments required
  15. *
  16. * @example
  17. * // How many milliseconds are between
  18. * // 2 July 2014 12:30:20.600 and 2 July 2014 12:30:21.700?
  19. * const result = differenceInMilliseconds(
  20. * new Date(2014, 6, 2, 12, 30, 21, 700),
  21. * new Date(2014, 6, 2, 12, 30, 20, 600)
  22. * )
  23. * //=> 1100
  24. */
  25. export default function differenceInMilliseconds(dateLeft, dateRight) {
  26. requiredArgs(2, arguments);
  27. return toDate(dateLeft).getTime() - toDate(dateRight).getTime();
  28. }