UNPKG

528 BTypeScriptView Raw
1/**
2 * @name endOfToday
3 * @category Day Helpers
4 * @summary Return the end of today.
5 * @pure false
6 *
7 * @description
8 * Return the end of today.
9 *
10 * @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).
11 *
12 * @returns The end of today
13 *
14 * @example
15 * // If today is 6 October 2014:
16 * const result = endOfToday()
17 * //=> Mon Oct 6 2014 23:59:59.999
18 */
19export declare function endOfToday(): Date;