30 lines
1.0 KiB
TypeScript
30 lines
1.0 KiB
TypeScript
/**
|
|
* @name isSameHour
|
|
* @category Hour Helpers
|
|
* @summary Are the given dates in the same hour (and same day)?
|
|
*
|
|
* @description
|
|
* Are the given dates in the same hour (and same day)?
|
|
*
|
|
* @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 dateLeft - The first date to check
|
|
* @param dateRight - The second date to check
|
|
*
|
|
* @returns The dates are in the same hour (and same day)
|
|
*
|
|
* @example
|
|
* // Are 4 September 2014 06:00:00 and 4 September 06:30:00 in the same hour?
|
|
* const result = isSameHour(new Date(2014, 8, 4, 6, 0), new Date(2014, 8, 4, 6, 30))
|
|
* //=> true
|
|
*
|
|
* @example
|
|
* // Are 4 September 2014 06:00:00 and 5 September 06:00:00 in the same hour?
|
|
* const result = isSameHour(new Date(2014, 8, 4, 6, 0), new Date(2014, 8, 5, 6, 0))
|
|
* //=> false
|
|
*/
|
|
export declare function isSameHour<DateType extends Date>(
|
|
dateLeft: DateType | number | string,
|
|
dateRight: DateType | number | string,
|
|
): boolean;
|