hugoWebsite/node_modules/date-fns/esm/endOfToday/index.js

24 lines
587 B
JavaScript
Raw Normal View History

2022-10-29 00:20:35 +02:00
import endOfDay from "../endOfDay/index.js";
/**
* @name endOfToday
* @category Day Helpers
* @summary Return the end of today.
* @pure false
*
* @description
* Return the end of today.
*
* > Please note that this function is not present in the FP submodule as
* > it uses `Date.now()` internally hence impure and can't be safely curried.
*
* @returns {Date} the end of today
*
* @example
* // If today is 6 October 2014:
* const result = endOfToday()
* //=> Mon Oct 6 2014 23:59:59.999
*/
export default function endOfToday() {
return endOfDay(Date.now());
}