addYears.d.mts 783 B

123456789101112131415161718192021222324
  1. /**
  2. * @name addYears
  3. * @category Year Helpers
  4. * @summary Add the specified number of years to the given date.
  5. *
  6. * @description
  7. * Add the specified number of years to 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 added.
  13. *
  14. * @returns The new date with the years added
  15. *
  16. * @example
  17. * // Add 5 years to 1 September 2014:
  18. * const result = addYears(new Date(2014, 8, 1), 5)
  19. * //=> Sun Sep 01 2019 00:00:00
  20. */
  21. export declare function addYears<DateType extends Date>(
  22. date: DateType | number | string,
  23. amount: number,
  24. ): DateType;