startOfHour.js 859 B

1234567891011121314151617181920212223242526272829
  1. "use strict";
  2. exports.startOfHour = startOfHour;
  3. var _index = require("./toDate.js");
  4. /**
  5. * @name startOfHour
  6. * @category Hour Helpers
  7. * @summary Return the start of an hour for the given date.
  8. *
  9. * @description
  10. * Return the start of an hour for the given date.
  11. * The result will be in the local timezone.
  12. *
  13. * @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).
  14. *
  15. * @param date - The original date
  16. *
  17. * @returns The start of an hour
  18. *
  19. * @example
  20. * // The start of an hour for 2 September 2014 11:55:00:
  21. * const result = startOfHour(new Date(2014, 8, 2, 11, 55))
  22. * //=> Tue Sep 02 2014 11:00:00
  23. */
  24. function startOfHour(date) {
  25. const _date = (0, _index.toDate)(date);
  26. _date.setMinutes(0, 0, 0);
  27. return _date;
  28. }