setYear.d.ts 728 B

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