setMinutes.cjs 1.1 KB

1234567891011121314151617181920212223242526272829303132333435
  1. "use strict";
  2. exports.setMinutes = setMinutes;
  3. var _index = require("./toDate.cjs");
  4. /**
  5. * The {@link setMinutes} function options.
  6. */
  7. /**
  8. * @name setMinutes
  9. * @category Minute Helpers
  10. * @summary Set the minutes to the given date.
  11. *
  12. * @description
  13. * Set the minutes to the given date.
  14. *
  15. * @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).
  16. * @typeParam ResultDate - The result `Date` type, returned from the context function, or inferred from the arguments.
  17. *
  18. * @param date - The date to be changed
  19. * @param minutes - The minutes of the new date
  20. * @param options - An object with options
  21. *
  22. * @returns The new date with the minutes set
  23. *
  24. * @example
  25. * // Set 45 minutes to 1 September 2014 11:30:40:
  26. * const result = setMinutes(new Date(2014, 8, 1, 11, 30, 40), 45)
  27. * //=> Mon Sep 01 2014 11:45:40
  28. */
  29. function setMinutes(date, minutes, options) {
  30. const date_ = (0, _index.toDate)(date, options?.in);
  31. date_.setMinutes(minutes);
  32. return date_;
  33. }