44 lines
1.4 KiB
TypeScript
44 lines
1.4 KiB
TypeScript
|
/**
|
||
|
|
* @name isSameSecond
|
||
|
|
* @category Second Helpers
|
||
|
|
* @summary Are the given dates in the same second (and hour and day)?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Are the given dates in the same second (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 second (and hour and day)
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Are 4 September 2014 06:30:15.000 and 4 September 2014 06:30.15.500 in the same second?
|
||
|
|
* const result = isSameSecond(
|
||
|
|
* new Date(2014, 8, 4, 6, 30, 15),
|
||
|
|
* new Date(2014, 8, 4, 6, 30, 15, 500)
|
||
|
|
* )
|
||
|
|
* //=> true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Are 4 September 2014 06:00:15.000 and 4 September 2014 06:01.15.000 in the same second?
|
||
|
|
* const result = isSameSecond(
|
||
|
|
* new Date(2014, 8, 4, 6, 0, 15),
|
||
|
|
* new Date(2014, 8, 4, 6, 1, 15)
|
||
|
|
* )
|
||
|
|
* //=> false
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Are 4 September 2014 06:00:15.000 and 5 September 2014 06:00.15.000 in the same second?
|
||
|
|
* const result = isSameSecond(
|
||
|
|
* new Date(2014, 8, 4, 6, 0, 15),
|
||
|
|
* new Date(2014, 8, 5, 6, 0, 15)
|
||
|
|
* )
|
||
|
|
* //=> false
|
||
|
|
*/
|
||
|
|
export declare function isSameSecond<DateType extends Date>(
|
||
|
|
dateLeft: DateType | number | string,
|
||
|
|
dateRight: DateType | number | string,
|
||
|
|
): boolean;
|