31 lines
864 B
JavaScript
31 lines
864 B
JavaScript
|
import { toDate } from "./toDate.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name startOfDay
|
||
|
|
* @category Day Helpers
|
||
|
|
* @summary Return the start of a day for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the start 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).
|
||
|
|
*
|
||
|
|
* @param date - The original date
|
||
|
|
*
|
||
|
|
* @returns The start of a day
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The start of a day for 2 September 2014 11:55:00:
|
||
|
|
* const result = startOfDay(new Date(2014, 8, 2, 11, 55, 0))
|
||
|
|
* //=> Tue Sep 02 2014 00:00:00
|
||
|
|
*/
|
||
|
|
export function startOfDay(date) {
|
||
|
|
const _date = toDate(date);
|
||
|
|
_date.setHours(0, 0, 0, 0);
|
||
|
|
return _date;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default startOfDay;
|