import toInteger from '../_lib/toInteger/index.js'; import getISOWeekYear from '../getISOWeekYear/index.js'; import setISOWeekYear from '../setISOWeekYear/index.js'; /** * @name addISOWeekYears * @category ISO Week-Numbering Year Helpers * @summary Add the specified number of ISO week-numbering years to the given date. * * @description * Add the specified number of ISO week-numbering years to the given date. * * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date * * ### 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). * * - The function was renamed from `addISOYears` to `addISOWeekYears`. * "ISO week year" is short for [ISO week-numbering year](https://en.wikipedia.org/wiki/ISO_week_date). * This change makes the name consistent with * locale-dependent week-numbering year helpers, e.g., `addWeekYears`. * * @param {Date|Number} date - the date to be changed * @param {Number} amount - the amount of ISO week-numbering years to be added * @returns {Date} the new date with the ISO week-numbering years added * @throws {TypeError} 2 arguments required * * @example * // Add 5 ISO week-numbering years to 2 July 2010: * var result = addISOWeekYears(new Date(2010, 6, 2), 5) * //=> Fri Jun 26 2015 00:00:00 */ export default function addISOWeekYears(dirtyDate, dirtyAmount) { if (arguments.length < 2) { throw new TypeError('2 arguments required, but only ' + arguments.length + ' present'); } var amount = toInteger(dirtyAmount); return setISOWeekYear(dirtyDate, getISOWeekYear(dirtyDate) + amount); }