isEqual.d.cts 643 B

1234567891011121314151617181920212223242526
  1. import type { DateArg } from "./types.js";
  2. /**
  3. * @name isEqual
  4. * @category Common Helpers
  5. * @summary Are the given dates equal?
  6. *
  7. * @description
  8. * Are the given dates equal?
  9. *
  10. * @param dateLeft - The first date to compare
  11. * @param dateRight - The second date to compare
  12. *
  13. * @returns The dates are equal
  14. *
  15. * @example
  16. * // Are 2 July 2014 06:30:45.000 and 2 July 2014 06:30:45.500 equal?
  17. * const result = isEqual(
  18. * new Date(2014, 6, 2, 6, 30, 45, 0),
  19. * new Date(2014, 6, 2, 6, 30, 45, 500)
  20. * )
  21. * //=> false
  22. */
  23. export declare function isEqual(
  24. leftDate: DateArg<Date> & {},
  25. rightDate: DateArg<Date> & {},
  26. ): boolean;