UNPKG

823 BTypeScriptView Raw
1/**
2 * @name isEqual
3 * @category Common Helpers
4 * @summary Are the given dates equal?
5 *
6 * @description
7 * Are the given dates equal?
8 *
9 * @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).
10 *
11 * @param dateLeft - The first date to compare
12 * @param dateRight - The second date to compare
13 *
14 * @returns The dates are equal
15 *
16 * @example
17 * // Are 2 July 2014 06:30:45.000 and 2 July 2014 06:30:45.500 equal?
18 * const result = isEqual(
19 * new Date(2014, 6, 2, 6, 30, 45, 0),
20 * new Date(2014, 6, 2, 6, 30, 45, 500)
21 * )
22 * //=> false
23 */
24export declare function isEqual<DateType extends Date>(
25 leftDate: DateType | number | string,
26 rightDate: DateType | number | string,
27): boolean;