endOfDay.js 1.1 KB

123456789101112131415161718192021222324252627282930313233343536
  1. import { toDate } from "./toDate.js";
  2. /**
  3. * The {@link endOfDay} function options.
  4. */
  5. /**
  6. * @name endOfDay
  7. * @category Day Helpers
  8. * @summary Return the end of a day for the given date.
  9. *
  10. * @description
  11. * Return the end of a day for the given date.
  12. * The result will be in the local timezone.
  13. *
  14. * @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).
  15. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  16. *
  17. * @param date - The original date
  18. * @param options - An object with options
  19. *
  20. * @returns The end of a day
  21. *
  22. * @example
  23. * // The end of a day for 2 September 2014 11:55:00:
  24. * const result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
  25. * //=> Tue Sep 02 2014 23:59:59.999
  26. */
  27. export function endOfDay(date, options) {
  28. const _date = toDate(date, options?.in);
  29. _date.setHours(23, 59, 59, 999);
  30. return _date;
  31. }
  32. // Fallback for modularized imports:
  33. export default endOfDay;