27 lines
990 B
JavaScript
27 lines
990 B
JavaScript
|
import toInteger from "../_lib/toInteger/index.js";
|
||
|
|
import addMonths from "../addMonths/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
/**
|
||
|
|
* @name addYears
|
||
|
|
* @category Year Helpers
|
||
|
|
* @summary Add the specified number of years to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Add the specified number of years to the given date.
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the date to be changed
|
||
|
|
* @param {Number} amount - the amount of years to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
|
||
|
|
* @returns {Date} the new date with the years added
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Add 5 years to 1 September 2014:
|
||
|
|
* const result = addYears(new Date(2014, 8, 1), 5)
|
||
|
|
* //=> Sun Sep 01 2019 00:00:00
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function addYears(dirtyDate, dirtyAmount) {
|
||
|
|
requiredArgs(2, arguments);
|
||
|
|
var amount = toInteger(dirtyAmount);
|
||
|
|
return addMonths(dirtyDate, amount * 12);
|
||
|
|
}
|