1234567891011121314151617181920212223242526272829303132333435 |
- "use strict";
- exports.startOfHour = startOfHour;
- var _index = require("./toDate.cjs");
- /**
- * The {@link startOfHour} function options.
- */
- /**
- * @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.
- *
- * @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).
- * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
- *
- * @param date - The original date
- * @param options - An object with options
- *
- * @returns The start of an hour
- *
- * @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
- */
- function startOfHour(date, options) {
- const _date = (0, _index.toDate)(date, options?.in);
- _date.setMinutes(0, 0, 0);
- return _date;
- }
|