123456789101112131415161718192021222324252627282930313233343536 |
- import { toDate } from "./toDate.js";
- /**
- * The {@link endOfDay} function options.
- */
- /**
- * @name endOfDay
- * @category Day Helpers
- * @summary Return the end of a day for the given date.
- *
- * @description
- * Return the end of a day for the given date.
- * The result will be in the local timezone.
- *
- * @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).
- * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
- *
- * @param date - The original date
- * @param options - An object with options
- *
- * @returns The end of a day
- *
- * @example
- * // The end of a day for 2 September 2014 11:55:00:
- * const result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
- * //=> Tue Sep 02 2014 23:59:59.999
- */
- export function endOfDay(date, options) {
- const _date = toDate(date, options?.in);
- _date.setHours(23, 59, 59, 999);
- return _date;
- }
- // Fallback for modularized imports:
- export default endOfDay;
|