12345678910111213141516171819202122232425262728293031323334 |
- import type { ContextOptions, DateArg } from "./types.js";
- /**
- * The {@link differenceInISOWeekYears} function options.
- */
- export interface DifferenceInISOWeekYearsOptions extends ContextOptions<Date> {}
- /**
- * @name differenceInISOWeekYears
- * @category ISO Week-Numbering Year Helpers
- * @summary Get the number of full ISO week-numbering years between the given dates.
- *
- * @description
- * Get the number of full 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 - The options
- *
- * @returns The number of full ISO week-numbering years
- *
- * @example
- * // How many full ISO week-numbering years are between 1 January 2010 and 1 January 2012?
- * const result = differenceInISOWeekYears(
- * new Date(2012, 0, 1),
- * new Date(2010, 0, 1)
- * )
- * // => 1
- */
- export declare function differenceInISOWeekYears(
- laterDate: DateArg<Date> & {},
- earlierDate: DateArg<Date> & {},
- options?: DifferenceInISOWeekYearsOptions | undefined,
- ): number;
|