UNPKG

539 BTypeScriptView Raw
1import { type DateLib } from "../classes/DateLib.js";
2/**
3 * Returns whether a date range contains one or more days of the week.
4 *
5 * ```tsx
6 * const range: DateRange = {
7 * from: new Date(2024, 8, 1), // Sunday
8 * to: new Date(2024, 8, 6) // Thursday
9 * };
10 * rangeContainsDayOfWeek(date, 1); // true: contains range contains Monday
11 * ```
12 *
13 * @since 9.2.2
14 * @group Utilities
15 */
16export declare function rangeContainsDayOfWeek(range: {
17 from: Date;
18 to: Date;
19}, dayOfWeek: number | number[], dateLib?: DateLib): boolean;