setDate.d.ts 801 B

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