1234567891011121314151617181920212223242526272829 |
- import type { ContextOptions, DateArg } from "./types.js";
- /**
- * The {@link isThisHour} function options.
- */
- export interface IsThisHourOptions extends ContextOptions<Date> {}
- /**
- * @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?
- *
- * @param date - The date to check
- * @param options - An object with options
- *
- * @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 declare function isThisHour(
- date: DateArg<Date> & {},
- options?: IsThisHourOptions,
- ): boolean;
|