40 lines
1.6 KiB
JavaScript
40 lines
1.6 KiB
JavaScript
|
import toInteger from '../_lib/toInteger/index.js';
|
||
|
|
import addISOWeekYears from '../addISOWeekYears/index.js';
|
||
|
|
/**
|
||
|
|
* @name subISOWeekYears
|
||
|
|
* @category ISO Week-Numbering Year Helpers
|
||
|
|
* @summary Subtract the specified number of ISO week-numbering years from the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Subtract the specified number of ISO week-numbering years from 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 `subISOYears` to `subISOWeekYears`.
|
||
|
|
* "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., `setWeekYear`.
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the date to be changed
|
||
|
|
* @param {Number} amount - the amount of ISO week-numbering years to be subtracted
|
||
|
|
* @returns {Date} the new date with the ISO week-numbering years subtracted
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Subtract 5 ISO week-numbering years from 1 September 2014:
|
||
|
|
* var result = subISOWeekYears(new Date(2014, 8, 1), 5)
|
||
|
|
* //=> Mon Aug 31 2009 00:00:00
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function subISOWeekYears(dirtyDate, dirtyAmount) {
|
||
|
|
if (arguments.length < 2) {
|
||
|
|
throw new TypeError('2 arguments required, but only ' + arguments.length + ' present');
|
||
|
|
}
|
||
|
|
|
||
|
|
var amount = toInteger(dirtyAmount);
|
||
|
|
return addISOWeekYears(dirtyDate, -amount);
|
||
|
|
}
|