30 lines
1.1 KiB
JavaScript
30 lines
1.1 KiB
JavaScript
|
import getISOWeekYear from "../getISOWeekYear/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
/**
|
||
|
|
* @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 {Date|Number} dateLeft - the later date
|
||
|
|
* @param {Date|Number} dateRight - the earlier date
|
||
|
|
* @returns {Number} the number of calendar ISO week-numbering years
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @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 default function differenceInCalendarISOWeekYears(dirtyDateLeft, dirtyDateRight) {
|
||
|
|
requiredArgs(2, arguments);
|
||
|
|
return getISOWeekYear(dirtyDateLeft) - getISOWeekYear(dirtyDateRight);
|
||
|
|
}
|