Skip to main content
Module

x/date_fns/addYears/index.ts

date-fns Deno package
Very Popular
Latest
File
import toInteger from '../_lib/toInteger/index.ts'import addMonths from '../addMonths/index.ts'import requiredArgs from '../_lib/requiredArgs/index.ts'
/** * @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. * * ### 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} 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: Date | number, dirtyAmount: number): Date { requiredArgs(2, arguments)
const amount = toInteger(dirtyAmount) return addMonths(dirtyDate, amount * 12)}