27 lines
786 B
JavaScript
27 lines
786 B
JavaScript
|
import toDate from "../toDate/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
/**
|
||
|
|
* @name startOfHour
|
||
|
|
* @category Hour Helpers
|
||
|
|
* @summary Return the start of an hour for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the start of an hour for the given date.
|
||
|
|
* The result will be in the local timezone.
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the original date
|
||
|
|
* @returns {Date} the start of an hour
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The start of an hour for 2 September 2014 11:55:00:
|
||
|
|
* const result = startOfHour(new Date(2014, 8, 2, 11, 55))
|
||
|
|
* //=> Tue Sep 02 2014 11:00:00
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function startOfHour(dirtyDate) {
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
var date = toDate(dirtyDate);
|
||
|
|
date.setMinutes(0, 0, 0);
|
||
|
|
return date;
|
||
|
|
}
|