| 1 | import { toDate } from "./toDate.js";
|
| 2 |
|
| 3 | /**
|
| 4 | * The {@link startOfHour} function options.
|
| 5 | */
|
| 6 |
|
| 7 | /**
|
| 8 | * @name startOfHour
|
| 9 | * @category Hour Helpers
|
| 10 | * @summary Return the start of an hour for the given date.
|
| 11 | *
|
| 12 | * @description
|
| 13 | * Return the start of an hour for the given date.
|
| 14 | * The result will be in the local timezone.
|
| 15 | *
|
| 16 | * @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).
|
| 17 | * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
| 18 | *
|
| 19 | * @param date - The original date
|
| 20 | * @param options - An object with options
|
| 21 | *
|
| 22 | * @returns The start of an hour
|
| 23 | *
|
| 24 | * @example
|
| 25 | * // The start of an hour for 2 September 2014 11:55:00:
|
| 26 | * const result = startOfHour(new Date(2014, 8, 2, 11, 55))
|
| 27 | * //=> Tue Sep 02 2014 11:00:00
|
| 28 | */
|
| 29 | export function startOfHour(date, options) {
|
| 30 | const _date = toDate(date, options?.in);
|
| 31 | _date.setMinutes(0, 0, 0);
|
| 32 | return _date;
|
| 33 | }
|
| 34 |
|
| 35 | // Fallback for modularized imports:
|
| 36 | export default startOfHour;
|