36 lines
1.2 KiB
JavaScript
36 lines
1.2 KiB
JavaScript
|
import toDate from '../toDate/index.js';
|
||
|
|
/**
|
||
|
|
* @name differenceInCalendarYears
|
||
|
|
* @category Year Helpers
|
||
|
|
* @summary Get the number of calendar years between the given dates.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of calendar years between the given dates.
|
||
|
|
*
|
||
|
|
* ### v2.0.0 breaking changes:
|
||
|
|
*
|
||
|
|
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
||
|
|
*
|
||
|
|
* @param {Date|Number} dateLeft - the later date
|
||
|
|
* @param {Date|Number} dateRight - the earlier date
|
||
|
|
* @returns {Number} the number of calendar years
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many calendar years are between 31 December 2013 and 11 February 2015?
|
||
|
|
* var result = differenceInCalendarYears(
|
||
|
|
* new Date(2015, 1, 11),
|
||
|
|
* new Date(2013, 11, 31)
|
||
|
|
* )
|
||
|
|
* //=> 2
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function differenceInCalendarYears(dirtyDateLeft, dirtyDateRight) {
|
||
|
|
if (arguments.length < 2) {
|
||
|
|
throw new TypeError('2 arguments required, but only ' + arguments.length + ' present');
|
||
|
|
}
|
||
|
|
|
||
|
|
var dateLeft = toDate(dirtyDateLeft);
|
||
|
|
var dateRight = toDate(dirtyDateRight);
|
||
|
|
return dateLeft.getFullYear() - dateRight.getFullYear();
|
||
|
|
}
|