32 lines
1.0 KiB
TypeScript
32 lines
1.0 KiB
TypeScript
|
import type { Interval } from "./types.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.
|
||
|
|
*
|
||
|
|
* @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 declare function eachWeekendOfInterval<DateType extends Date>(
|
||
|
|
interval: Interval<DateType>,
|
||
|
|
): DateType[];
|