| 123456789101112131415161718192021222324252627282930 |
- import { constructNow } from "./constructNow.mjs";
- import { isSameHour } from "./isSameHour.mjs";
- /**
- * @name isThisHour
- * @category Hour Helpers
- * @summary Is the given date in the same hour as the current date?
- * @pure false
- *
- * @description
- * Is the given date in the same hour as the current date?
- *
- * @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 date to check
- *
- * @returns The date is in this hour
- *
- * @example
- * // If now is 25 September 2014 18:30:15.500,
- * // is 25 September 2014 18:00:00 in this hour?
- * const result = isThisHour(new Date(2014, 8, 25, 18))
- * //=> true
- */
- export function isThisHour(date) {
- return isSameHour(date, constructNow(date));
- }
- // Fallback for modularized imports:
- export default isThisHour;
|