12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849 |
- import eachDayOfInterval from "../eachDayOfInterval/index.js";
- import isSunday from "../isSunday/index.js";
- import isWeekend from "../isWeekend/index.js";
- import requiredArgs from "../_lib/requiredArgs/index.js";
- /**
- * @name eachWeekendOfInterval
- * @category Interval Helpers
- * @summary List all the Saturdays and Sundays in the given date interval.
- *
- * @description
- * Get all the Saturdays and Sundays in the given date interval.
- *
- * @param {Interval} interval - the given interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns {Date[]} an array containing all the Saturdays and Sundays
- * @throws {TypeError} 1 argument required
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
- *
- * @example
- * // Lists all Saturdays and Sundays in the given date interval
- * const result = eachWeekendOfInterval({
- * start: new Date(2018, 8, 17),
- * end: new Date(2018, 8, 30)
- * })
- * //=> [
- * // Sat Sep 22 2018 00:00:00,
- * // Sun Sep 23 2018 00:00:00,
- * // Sat Sep 29 2018 00:00:00,
- * // Sun Sep 30 2018 00:00:00
- * // ]
- */
- export default function eachWeekendOfInterval(interval) {
- requiredArgs(1, arguments);
- var dateInterval = eachDayOfInterval(interval);
- var weekends = [];
- var index = 0;
- while (index < dateInterval.length) {
- var date = dateInterval[index++];
- if (isWeekend(date)) {
- weekends.push(date);
- if (isSunday(date)) index = index + 5;
- }
- }
- return weekends;
- }
|