12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- import addWeeks from "../addWeeks/index.js";
- import startOfWeek from "../startOfWeek/index.js";
- import toDate from "../toDate/index.js";
- import requiredArgs from "../_lib/requiredArgs/index.js";
- /**
- * @name eachWeekOfInterval
- * @category Interval Helpers
- * @summary Return the array of weeks within the specified time interval.
- *
- * @description
- * Return the array of weeks within the specified time interval.
- *
- * ### v2.0.0 breaking changes:
- *
- * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
- *
- * @param {Interval} interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param {Object} [options] - an object with options.
- * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
- * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
- * @returns {Date[]} the array with starts of weeks from the week of the interval start to the week of the interval end
- * @throws {TypeError} 1 argument required
- * @throws {RangeError} `options.weekStartsOn` must be 0, 1, ..., 6
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Each week within interval 6 October 2014 - 23 November 2014:
- * var result = eachWeekOfInterval({
- * start: new Date(2014, 9, 6),
- * end: new Date(2014, 10, 23)
- * })
- * //=> [
- * // Sun Oct 05 2014 00:00:00,
- * // Sun Oct 12 2014 00:00:00,
- * // Sun Oct 19 2014 00:00:00,
- * // Sun Oct 26 2014 00:00:00,
- * // Sun Nov 02 2014 00:00:00,
- * // Sun Nov 09 2014 00:00:00,
- * // Sun Nov 16 2014 00:00:00,
- * // Sun Nov 23 2014 00:00:00
- * // ]
- */
- export default function eachWeekOfInterval(dirtyInterval, options) {
- requiredArgs(1, arguments);
- var interval = dirtyInterval || {};
- var startDate = toDate(interval.start);
- var endDate = toDate(interval.end);
- var endTime = endDate.getTime(); // Throw an exception if start date is after end date or if any date is `Invalid Date`
- if (!(startDate.getTime() <= endTime)) {
- throw new RangeError('Invalid interval');
- }
- var startDateWeek = startOfWeek(startDate, options);
- var endDateWeek = startOfWeek(endDate, options); // Some timezones switch DST at midnight, making start of day unreliable in these timezones, 3pm is a safe bet
- startDateWeek.setHours(15);
- endDateWeek.setHours(15);
- endTime = endDateWeek.getTime();
- var weeks = [];
- var currentWeek = startDateWeek;
- while (currentWeek.getTime() <= endTime) {
- currentWeek.setHours(0);
- weeks.push(toDate(currentWeek));
- currentWeek = addWeeks(currentWeek, 1);
- currentWeek.setHours(15);
- }
- return weeks;
- }
|