index.js 951 B

12345678910111213141516171819202122232425262728293031
  1. import toDate from "../toDate/index.js";
  2. import requiredArgs from "../_lib/requiredArgs/index.js";
  3. /**
  4. * @name endOfDay
  5. * @category Day Helpers
  6. * @summary Return the end of a day for the given date.
  7. *
  8. * @description
  9. * Return the end of a day for the given date.
  10. * The result will be in the local timezone.
  11. *
  12. * ### v2.0.0 breaking changes:
  13. *
  14. * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
  15. *
  16. * @param {Date|Number} date - the original date
  17. * @returns {Date} the end of a day
  18. * @throws {TypeError} 1 argument required
  19. *
  20. * @example
  21. * // The end of a day for 2 September 2014 11:55:00:
  22. * const result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
  23. * //=> Tue Sep 02 2014 23:59:59.999
  24. */
  25. export default function endOfDay(dirtyDate) {
  26. requiredArgs(1, arguments);
  27. var date = toDate(dirtyDate);
  28. date.setHours(23, 59, 59, 999);
  29. return date;
  30. }