import type { ContextOptions, Interval } from '../types.ts'; /** * The {@link eachWeekendOfInterval} function options. */ export interface EachWeekendOfIntervalOptions extends ContextOptions { } /** * The {@link eachWeekendOfInterval} function result type. */ export type EachWeekendOfIntervalResult = Array ? DateType : IntervalType['start'] extends Date ? IntervalType['start'] : IntervalType['end'] extends Date ? IntervalType['end'] : Date>; /** * @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 IntervalType - Interval type. * @typeParam Options - Options type. * * @param interval - The given interval * @param options - An object with options * * @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(interval: IntervalType, options?: Options): EachWeekendOfIntervalResult;