endOfMinute.js 874 B

1234567891011121314151617181920212223242526272829
  1. "use strict";
  2. exports.endOfMinute = endOfMinute;
  3. var _index = require("./toDate.js");
  4. /**
  5. * @name endOfMinute
  6. * @category Minute Helpers
  7. * @summary Return the end of a minute for the given date.
  8. *
  9. * @description
  10. * Return the end of a minute for the given date.
  11. * The result will be in the local timezone.
  12. *
  13. * @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).
  14. *
  15. * @param date - The original date
  16. *
  17. * @returns The end of a minute
  18. *
  19. * @example
  20. * // The end of a minute for 1 December 2014 22:15:45.400:
  21. * const result = endOfMinute(new Date(2014, 11, 1, 22, 15, 45, 400))
  22. * //=> Mon Dec 01 2014 22:15:59.999
  23. */
  24. function endOfMinute(date) {
  25. const _date = (0, _index.toDate)(date);
  26. _date.setSeconds(59, 999);
  27. return _date;
  28. }