27 lines
657 B
JavaScript
27 lines
657 B
JavaScript
|
import { endOfDay } from "./endOfDay.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name endOfToday
|
||
|
|
* @category Day Helpers
|
||
|
|
* @summary Return the end of today.
|
||
|
|
* @pure false
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the end of today.
|
||
|
|
*
|
||
|
|
* @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).
|
||
|
|
*
|
||
|
|
* @returns The end of today
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If today is 6 October 2014:
|
||
|
|
* const result = endOfToday()
|
||
|
|
* //=> Mon Oct 6 2014 23:59:59.999
|
||
|
|
*/
|
||
|
|
export function endOfToday() {
|
||
|
|
return endOfDay(Date.now());
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default endOfToday;
|