diff options
Diffstat (limited to 'date-fns/src/isEqual/index.ts')
-rw-r--r-- | date-fns/src/isEqual/index.ts | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/date-fns/src/isEqual/index.ts b/date-fns/src/isEqual/index.ts new file mode 100644 index 0000000..1157e62 --- /dev/null +++ b/date-fns/src/isEqual/index.ts @@ -0,0 +1,35 @@ +import toDate from '../toDate/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name isEqual + * @category Common Helpers + * @summary Are the given dates equal? + * + * @description + * Are the given dates equal? + * + * ### v2.0.0 breaking changes: + * + * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes). + * + * @param {Date|Number} dateLeft - the first date to compare + * @param {Date|Number} dateRight - the second date to compare + * @returns {Boolean} the dates are equal + * @throws {TypeError} 2 arguments required + * + * @example + * // Are 2 July 2014 06:30:45.000 and 2 July 2014 06:30:45.500 equal? + * var result = isEqual( + * new Date(2014, 6, 2, 6, 30, 45, 0), + * new Date(2014, 6, 2, 6, 30, 45, 500) + * ) + * //=> false + */ +export default function isEqual(dirtyLeftDate: Date | number, dirtyRightDate: Date | number): boolean { + requiredArgs(2, arguments) + + const dateLeft = toDate(dirtyLeftDate) + const dateRight = toDate(dirtyRightDate) + return dateLeft.getTime() === dateRight.getTime() +} |