index.js 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = differenceInCalendarDays;
  7. var _index = _interopRequireDefault(require("../_lib/getTimezoneOffsetInMilliseconds/index.js"));
  8. var _index2 = _interopRequireDefault(require("../startOfDay/index.js"));
  9. var _index3 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  10. var MILLISECONDS_IN_DAY = 86400000;
  11. /**
  12. * @name differenceInCalendarDays
  13. * @category Day Helpers
  14. * @summary Get the number of calendar days between the given dates.
  15. *
  16. * @description
  17. * Get the number of calendar days between the given dates. This means that the times are removed
  18. * from the dates and then the difference in days is calculated.
  19. *
  20. * @param {Date|Number} dateLeft - the later date
  21. * @param {Date|Number} dateRight - the earlier date
  22. * @returns {Number} the number of calendar days
  23. * @throws {TypeError} 2 arguments required
  24. *
  25. * @example
  26. * // How many calendar days are between
  27. * // 2 July 2011 23:00:00 and 2 July 2012 00:00:00?
  28. * const result = differenceInCalendarDays(
  29. * new Date(2012, 6, 2, 0, 0),
  30. * new Date(2011, 6, 2, 23, 0)
  31. * )
  32. * //=> 366
  33. * // How many calendar days are between
  34. * // 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
  35. * const result = differenceInCalendarDays(
  36. * new Date(2011, 6, 3, 0, 1),
  37. * new Date(2011, 6, 2, 23, 59)
  38. * )
  39. * //=> 1
  40. */
  41. function differenceInCalendarDays(dirtyDateLeft, dirtyDateRight) {
  42. (0, _index3.default)(2, arguments);
  43. var startOfDayLeft = (0, _index2.default)(dirtyDateLeft);
  44. var startOfDayRight = (0, _index2.default)(dirtyDateRight);
  45. var timestampLeft = startOfDayLeft.getTime() - (0, _index.default)(startOfDayLeft);
  46. var timestampRight = startOfDayRight.getTime() - (0, _index.default)(startOfDayRight);
  47. // Round the number of days to the nearest integer
  48. // because the number of milliseconds in a day is not constant
  49. // (e.g. it's different in the day of the daylight saving time clock shift)
  50. return Math.round((timestampLeft - timestampRight) / MILLISECONDS_IN_DAY);
  51. }
  52. module.exports = exports.default;