index.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = eachWeekOfInterval;
  7. var _index = _interopRequireDefault(require("../addWeeks/index.js"));
  8. var _index2 = _interopRequireDefault(require("../startOfWeek/index.js"));
  9. var _index3 = _interopRequireDefault(require("../toDate/index.js"));
  10. var _index4 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  11. /**
  12. * @name eachWeekOfInterval
  13. * @category Interval Helpers
  14. * @summary Return the array of weeks within the specified time interval.
  15. *
  16. * @description
  17. * Return the array of weeks within the specified time interval.
  18. *
  19. * @param {Interval} interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
  20. * @param {Object} [options] - an object with options.
  21. * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
  22. * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
  23. * @returns {Date[]} the array with starts of weeks from the week of the interval start to the week of the interval end
  24. * @throws {TypeError} 1 argument required
  25. * @throws {RangeError} `options.weekStartsOn` must be 0, 1, ..., 6
  26. * @throws {RangeError} The start of an interval cannot be after its end
  27. * @throws {RangeError} Date in interval cannot be `Invalid Date`
  28. *
  29. * @example
  30. * // Each week within interval 6 October 2014 - 23 November 2014:
  31. * const result = eachWeekOfInterval({
  32. * start: new Date(2014, 9, 6),
  33. * end: new Date(2014, 10, 23)
  34. * })
  35. * //=> [
  36. * // Sun Oct 05 2014 00:00:00,
  37. * // Sun Oct 12 2014 00:00:00,
  38. * // Sun Oct 19 2014 00:00:00,
  39. * // Sun Oct 26 2014 00:00:00,
  40. * // Sun Nov 02 2014 00:00:00,
  41. * // Sun Nov 09 2014 00:00:00,
  42. * // Sun Nov 16 2014 00:00:00,
  43. * // Sun Nov 23 2014 00:00:00
  44. * // ]
  45. */
  46. function eachWeekOfInterval(dirtyInterval, options) {
  47. (0, _index4.default)(1, arguments);
  48. var interval = dirtyInterval || {};
  49. var startDate = (0, _index3.default)(interval.start);
  50. var endDate = (0, _index3.default)(interval.end);
  51. var endTime = endDate.getTime();
  52. // Throw an exception if start date is after end date or if any date is `Invalid Date`
  53. if (!(startDate.getTime() <= endTime)) {
  54. throw new RangeError('Invalid interval');
  55. }
  56. var startDateWeek = (0, _index2.default)(startDate, options);
  57. var endDateWeek = (0, _index2.default)(endDate, options);
  58. // Some timezones switch DST at midnight, making start of day unreliable in these timezones, 3pm is a safe bet
  59. startDateWeek.setHours(15);
  60. endDateWeek.setHours(15);
  61. endTime = endDateWeek.getTime();
  62. var weeks = [];
  63. var currentWeek = startDateWeek;
  64. while (currentWeek.getTime() <= endTime) {
  65. currentWeek.setHours(0);
  66. weeks.push((0, _index3.default)(currentWeek));
  67. currentWeek = (0, _index.default)(currentWeek, 1);
  68. currentWeek.setHours(15);
  69. }
  70. return weeks;
  71. }
  72. module.exports = exports.default;