30 lines
1.0 KiB
TypeScript
30 lines
1.0 KiB
TypeScript
/**
|
|
* @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
|
|
*
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
|
*
|
|
* @param dateLeft - The later date
|
|
* @param dateRight - The earlier date
|
|
*
|
|
* @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<DateType extends Date>(
|
|
dateLeft: DateType | number | string,
|
|
dateRight: DateType | number | string,
|
|
): number;
|