| 12345678910111213141516171819202122232425262728293031323334353637383940414243 |
- import { eachDayOfInterval } from "./eachDayOfInterval.mjs";
- import { isWeekend } from "./isWeekend.mjs";
- /**
- * @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.
- *
- * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
- *
- * @param interval - The given interval
- *
- * @returns An array containing all the Saturdays and Sundays
- *
- * @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 function eachWeekendOfInterval(interval) {
- const dateInterval = eachDayOfInterval(interval);
- const weekends = [];
- let index = 0;
- while (index < dateInterval.length) {
- const date = dateInterval[index++];
- if (isWeekend(date)) weekends.push(date);
- }
- return weekends;
- }
- // Fallback for modularized imports:
- export default eachWeekendOfInterval;
|