1234567891011121314151617181920212223242526272829 |
- import toDate from "../toDate/index.js";
- import requiredArgs from "../_lib/requiredArgs/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.
- *
- * @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?
- * const result = differenceInCalendarYears(
- * new Date(2015, 1, 11),
- * new Date(2013, 11, 31)
- * )
- * //=> 2
- */
- export default function differenceInCalendarYears(dirtyDateLeft, dirtyDateRight) {
- requiredArgs(2, arguments);
- var dateLeft = toDate(dirtyDateLeft);
- var dateRight = toDate(dirtyDateRight);
- return dateLeft.getFullYear() - dateRight.getFullYear();
- }
|