1234567891011121314151617181920212223242526272829303132333435 |
- import type { ContextOptions, DateArg } from "./types.js";
- /**
- * The {@link differenceInCalendarISOWeekYears} function options.
- */
- export interface DifferenceInCalendarISOWeekYearsOptions
- extends ContextOptions<Date> {}
- /**
- * @name differenceInCalendarISOWeekYears
- * @category ISO Week-Numbering Year Helpers
- * @summary Get the number of calendar ISO week-numbering years between the given dates.
- *
- * @description
- * Get the number of calendar ISO week-numbering years between the given dates.
- *
- * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
- *
- * @param laterDate - The later date
- * @param earlierDate - The earlier date
- * @param options - An object with options
- *
- * @returns The number of calendar ISO week-numbering years
- *
- * @example
- * // How many calendar ISO week-numbering years are 1 January 2010 and 1 January 2012?
- * const result = differenceInCalendarISOWeekYears(
- * new Date(2012, 0, 1),
- * new Date(2010, 0, 1)
- * )
- * //=> 2
- */
- export declare function differenceInCalendarISOWeekYears(
- laterDate: DateArg<Date> & {},
- earlierDate: DateArg<Date> & {},
- options?: DifferenceInCalendarISOWeekYearsOptions | undefined,
- ): number;
|