| 1 | import type { ContextOptions, DateArg } from "./types.js";
|
| 2 | /**
|
| 3 | * The {@link isSameISOWeekYear} function options.
|
| 4 | */
|
| 5 | export interface IsSameISOWeekYearOptions extends ContextOptions<Date> {}
|
| 6 | /**
|
| 7 | * @name isSameISOWeekYear
|
| 8 | * @category ISO Week-Numbering Year Helpers
|
| 9 | * @summary Are the given dates in the same ISO week-numbering year?
|
| 10 | *
|
| 11 | * @description
|
| 12 | * Are the given dates in the same ISO week-numbering year?
|
| 13 | *
|
| 14 | * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
|
| 15 | *
|
| 16 | * @param laterDate - The first date to check
|
| 17 | * @param earlierDate - The second date to check
|
| 18 | * @param options - An object with options
|
| 19 | *
|
| 20 | * @returns The dates are in the same ISO week-numbering year
|
| 21 | *
|
| 22 | * @example
|
| 23 | * // Are 29 December 2003 and 2 January 2005 in the same ISO week-numbering year?
|
| 24 | * const result = isSameISOWeekYear(new Date(2003, 11, 29), new Date(2005, 0, 2))
|
| 25 | * //=> true
|
| 26 | */
|
| 27 | export declare function isSameISOWeekYear(
|
| 28 | laterDate: DateArg<Date> & {},
|
| 29 | earlierDate: DateArg<Date> & {},
|
| 30 | options?: IsSameISOWeekYearOptions | undefined,
|
| 31 | ): boolean;
|