index.js 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = differenceInCalendarWeeks;
  7. var _index = _interopRequireDefault(require("../startOfWeek/index.js"));
  8. var _index2 = _interopRequireDefault(require("../_lib/getTimezoneOffsetInMilliseconds/index.js"));
  9. var _index3 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  10. var MILLISECONDS_IN_WEEK = 604800000;
  11. /**
  12. * @name differenceInCalendarWeeks
  13. * @category Week Helpers
  14. * @summary Get the number of calendar weeks between the given dates.
  15. *
  16. * @description
  17. * Get the number of calendar weeks between the given dates.
  18. *
  19. * @param {Date|Number} dateLeft - the later date
  20. * @param {Date|Number} dateRight - the earlier date
  21. * @param {Object} [options] - an object with options.
  22. * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
  23. * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
  24. * @returns {Number} the number of calendar weeks
  25. * @throws {TypeError} 2 arguments required
  26. * @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
  27. *
  28. * @example
  29. * // How many calendar weeks are between 5 July 2014 and 20 July 2014?
  30. * const result = differenceInCalendarWeeks(
  31. * new Date(2014, 6, 20),
  32. * new Date(2014, 6, 5)
  33. * )
  34. * //=> 3
  35. *
  36. * @example
  37. * // If the week starts on Monday,
  38. * // how many calendar weeks are between 5 July 2014 and 20 July 2014?
  39. * const result = differenceInCalendarWeeks(
  40. * new Date(2014, 6, 20),
  41. * new Date(2014, 6, 5),
  42. * { weekStartsOn: 1 }
  43. * )
  44. * //=> 2
  45. */
  46. function differenceInCalendarWeeks(dirtyDateLeft, dirtyDateRight, options) {
  47. (0, _index3.default)(2, arguments);
  48. var startOfWeekLeft = (0, _index.default)(dirtyDateLeft, options);
  49. var startOfWeekRight = (0, _index.default)(dirtyDateRight, options);
  50. var timestampLeft = startOfWeekLeft.getTime() - (0, _index2.default)(startOfWeekLeft);
  51. var timestampRight = startOfWeekRight.getTime() - (0, _index2.default)(startOfWeekRight);
  52. // Round the number of days to the nearest integer
  53. // because the number of milliseconds in a week is not constant
  54. // (e.g. it's different in the week of the daylight saving time clock shift)
  55. return Math.round((timestampLeft - timestampRight) / MILLISECONDS_IN_WEEK);
  56. }
  57. module.exports = exports.default;