setDayOfYear.cjs 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. "use strict";
  2. exports.setDayOfYear = setDayOfYear;
  3. var _index = require("./toDate.cjs");
  4. /**
  5. * The {@link setDayOfYear} function options.
  6. */
  7. /**
  8. * @name setDayOfYear
  9. * @category Day Helpers
  10. * @summary Set the day of the year to the given date.
  11. *
  12. * @description
  13. * Set the day of the year to the given date.
  14. *
  15. * @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).
  16. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  17. *
  18. * @param date - The date to be changed
  19. * @param dayOfYear - The day of the year of the new date
  20. * @param options - An object with options
  21. *
  22. * @returns The new date with the day of the year set
  23. *
  24. * @example
  25. * // Set the 2nd day of the year to 2 July 2014:
  26. * const result = setDayOfYear(new Date(2014, 6, 2), 2)
  27. * //=> Thu Jan 02 2014 00:00:00
  28. */
  29. function setDayOfYear(date, dayOfYear, options) {
  30. const date_ = (0, _index.toDate)(date, options?.in);
  31. date_.setMonth(0);
  32. date_.setDate(dayOfYear);
  33. return date_;
  34. }