Function subYears

subYears<DateType extends Date, ResultDate extends Date = DateType>(
    date: DateArg<DateType>,
    amount: number,
    options?: SubYearsOptions<ResultDate>,
): ResultDate
Type Parameters
- DateType extends Date
  The Date type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like UTCDate.
- ResultDate extends Date = DateType
  The result Date type, it is the type returned from the context function if it is passed, or inferred from the arguments.
Parameters
- date: DateArg<DateType>
  The date to be changed
- amount: number
  The amount of years to be subtracted.
- Optionaloptions: SubYearsOptions<ResultDate>
  An object with options
Returns ResultDate
The new date with the years subtracted
Name
subYears

Description
Subtract the specified number of years from the given date.
Example
```
// Subtract 5 years from 1 September 2014:
const result = subYears(new Date(2014, 8, 1), 5)
//=> Tue Sep 01 2009 00:00:00
```
- Defined in node_modules/date-fns/subYears.d.ts:29