UNPKG

814 BTypeScriptView Raw
1/**
2 * @name subYears
3 * @category Year Helpers
4 * @summary Subtract the specified number of years from the given date.
5 *
6 * @description
7 * Subtract the specified number of years from the given date.
8 *
9 * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
10 *
11 * @param date - The date to be changed
12 * @param amount - The amount of years to be subtracted.
13 *
14 * @returns The new date with the years subtracted
15 *
16 * @example
17 * // Subtract 5 years from 1 September 2014:
18 * const result = subYears(new Date(2014, 8, 1), 5)
19 * //=> Tue Sep 01 2009 00:00:00
20 */
21export declare function subYears<DateType extends Date>(
22 date: DateType | number | string,
23 amount: number,
24): DateType;