summaryrefslogtreecommitdiff
path: root/date-fns/src/isSameQuarter/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/isSameQuarter/index.ts')
-rw-r--r--date-fns/src/isSameQuarter/index.ts33
1 files changed, 33 insertions, 0 deletions
diff --git a/date-fns/src/isSameQuarter/index.ts b/date-fns/src/isSameQuarter/index.ts
new file mode 100644
index 0000000..84d84d4
--- /dev/null
+++ b/date-fns/src/isSameQuarter/index.ts
@@ -0,0 +1,33 @@
+import startOfQuarter from '../startOfQuarter/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name isSameQuarter
+ * @category Quarter Helpers
+ * @summary Are the given dates in the same year quarter?
+ *
+ * @description
+ * Are the given dates in the same year quarter?
+ *
+ * ### 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 quarter
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // Are 1 January 2014 and 8 March 2014 in the same quarter?
+ * var result = isSameQuarter(new Date(2014, 0, 1), new Date(2014, 2, 8))
+ * //=> true
+ */
+export default function isSameQuarter(dirtyDateLeft: Date | number, dirtyDateRight: Date | number): boolean {
+ requiredArgs(2, arguments)
+
+ const dateLeftStartOfQuarter = startOfQuarter(dirtyDateLeft)
+ const dateRightStartOfQuarter = startOfQuarter(dirtyDateRight)
+
+ return dateLeftStartOfQuarter.getTime() === dateRightStartOfQuarter.getTime()
+}