setDate.js 1.1 KB

123456789101112131415161718192021222324252627282930313233343536
  1. import { toDate } from "./toDate.js";
  2. /**
  3. * The {@link setDate} function options.
  4. */
  5. /**
  6. * @name setDate
  7. * @category Day Helpers
  8. * @summary Set the day of the month to the given date.
  9. *
  10. * @description
  11. * Set the day of the month to the given date.
  12. *
  13. * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows using extensions like [`UTCDate`](https://github.com/date-fns/utc).
  14. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  15. *
  16. * @param date - The date to be changed
  17. * @param dayOfMonth - The day of the month of the new date
  18. * @param options - The options
  19. *
  20. * @returns The new date with the day of the month set
  21. *
  22. * @example
  23. * // Set the 30th day of the month to 1 September 2014:
  24. * const result = setDate(new Date(2014, 8, 1), 30)
  25. * //=> Tue Sep 30 2014 00:00:00
  26. */
  27. export function setDate(date, dayOfMonth, options) {
  28. const _date = toDate(date, options?.in);
  29. _date.setDate(dayOfMonth);
  30. return _date;
  31. }
  32. // Fallback for modularized imports:
  33. export default setDate;