summaryrefslogtreecommitdiff
path: root/date-fns/src/isSameHour/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/isSameHour/index.ts')
-rw-r--r--date-fns/src/isSameHour/index.ts33
1 files changed, 33 insertions, 0 deletions
diff --git a/date-fns/src/isSameHour/index.ts b/date-fns/src/isSameHour/index.ts
new file mode 100644
index 0000000..d6e362e
--- /dev/null
+++ b/date-fns/src/isSameHour/index.ts
@@ -0,0 +1,33 @@
+import startOfHour from '../startOfHour/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name isSameHour
+ * @category Hour Helpers
+ * @summary Are the given dates in the same hour?
+ *
+ * @description
+ * Are the given dates in the same hour?
+ *
+ * ### 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 check
+ * @param {Date|Number} dateRight - the second date to check
+ * @returns {Boolean} the dates are in the same hour
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // Are 4 September 2014 06:00:00 and 4 September 06:30:00 in the same hour?
+ * var result = isSameHour(new Date(2014, 8, 4, 6, 0), new Date(2014, 8, 4, 6, 30))
+ * //=> true
+ */
+export default function isSameHour(dirtyDateLeft: Date | number, dirtyDateRight: Date | number): boolean {
+ requiredArgs(2, arguments)
+
+ const dateLeftStartOfHour = startOfHour(dirtyDateLeft)
+ const dateRightStartOfHour = startOfHour(dirtyDateRight)
+
+ return dateLeftStartOfHour.getTime() === dateRightStartOfHour.getTime()
+}