123456789101112131415161718192021222324252627282930313233343536373839404142 |
- import type {
- ContextOptions,
- DateArg,
- LocalizedOptions,
- WeekOptions,
- } from "./types.js";
- /**
- * The {@link isThisWeek} function options.
- */
- export interface IsThisWeekOptions
- extends WeekOptions,
- LocalizedOptions<"options">,
- ContextOptions<Date> {}
- /**
- * @name isThisWeek
- * @category Week Helpers
- * @summary Is the given date in the same week as the current date?
- * @pure false
- *
- * @description
- * Is the given date in the same week as the current date?
- *
- * @param date - The date to check
- * @param options - The object with options
- *
- * @returns The date is in this week
- *
- * @example
- * // If today is 25 September 2014, is 21 September 2014 in this week?
- * const result = isThisWeek(new Date(2014, 8, 21))
- * //=> true
- *
- * @example
- * // If today is 25 September 2014 and week starts with Monday
- * // is 21 September 2014 in this week?
- * const result = isThisWeek(new Date(2014, 8, 21), { weekStartsOn: 1 })
- * //=> false
- */
- export declare function isThisWeek(
- date: DateArg<Date> & {},
- options?: IsThisWeekOptions,
- ): boolean;
|