28 lines
777 B
JavaScript
28 lines
777 B
JavaScript
|
import startOfDay from '../startOfDay/index.js';
|
|||
|
|
/**
|
|||
|
|
* @name startOfToday
|
|||
|
|
* @category Day Helpers
|
|||
|
|
* @summary Return the start of today.
|
|||
|
|
* @pure false
|
|||
|
|
*
|
|||
|
|
* @description
|
|||
|
|
* Return the start 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.
|
|||
|
|
*
|
|||
|
|
* ### v2.0.0 breaking changes:
|
|||
|
|
*
|
|||
|
|
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
|||
|
|
*
|
|||
|
|
* @returns {Date} the start of today
|
|||
|
|
*
|
|||
|
|
* @example
|
|||
|
|
* // If today is 6 October 2014:
|
|||
|
|
* var result = startOfToday()
|
|||
|
|
* //=> Mon Oct 6 2014 00:00:00
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
export default function startOfToday() {
|
|||
|
|
return startOfDay(Date.now());
|
|||
|
|
}
|