36 lines
1.1 KiB
TypeScript
36 lines
1.1 KiB
TypeScript
/**
|
|
* @name isSameMinute
|
|
* @category Minute Helpers
|
|
* @summary Are the given dates in the same minute (and hour and day)?
|
|
*
|
|
* @description
|
|
* Are the given dates in the same minute (and hour and 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 minute (and hour and day)
|
|
*
|
|
* @example
|
|
* // Are 4 September 2014 06:30:00 and 4 September 2014 06:30:15 in the same minute?
|
|
* const result = isSameMinute(
|
|
* new Date(2014, 8, 4, 6, 30),
|
|
* new Date(2014, 8, 4, 6, 30, 15)
|
|
* )
|
|
* //=> true
|
|
*
|
|
* @example
|
|
* // Are 4 September 2014 06:30:00 and 5 September 2014 06:30:00 in the same minute?
|
|
* const result = isSameMinute(
|
|
* new Date(2014, 8, 4, 6, 30),
|
|
* new Date(2014, 8, 5, 6, 30)
|
|
* )
|
|
* //=> false
|
|
*/
|
|
export declare function isSameMinute<DateType extends Date>(
|
|
dateLeft: DateType | number | string,
|
|
dateRight: DateType | number | string,
|
|
): boolean;
|