Skip to main content
Module

x/date_fns/subYears/index.ts

date-fns Deno package
Very Popular
Latest
File
import toInteger from '../_lib/toInteger/index.ts'import addYears from '../addYears/index.ts'import requiredArgs from '../_lib/requiredArgs/index.ts'
/** * @name subYears * @category Year Helpers * @summary Subtract the specified number of years from the given date. * * @description * Subtract the specified number of years from 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 subtracted. 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 subtracted * @throws {TypeError} 2 arguments required * * @example * // Subtract 5 years from 1 September 2014: * const result = subYears(new Date(2014, 8, 1), 5) * //=> Tue Sep 01 2009 00:00:00 */export default function subYears(dirtyDate: Date | number, dirtyAmount: number): Date { requiredArgs(2, arguments)
const amount = toInteger(dirtyAmount) return addYears(dirtyDate, -amount)}