summaryrefslogtreecommitdiff
path: root/date-fns/src/isSameWeek/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/isSameWeek/index.ts')
-rw-r--r--date-fns/src/isSameWeek/index.ts50
1 files changed, 50 insertions, 0 deletions
diff --git a/date-fns/src/isSameWeek/index.ts b/date-fns/src/isSameWeek/index.ts
new file mode 100644
index 0000000..692d8b7
--- /dev/null
+++ b/date-fns/src/isSameWeek/index.ts
@@ -0,0 +1,50 @@
+import startOfWeek from '../startOfWeek/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+import { WeekStartOptions, LocaleOptions } from '../types'
+
+/**
+ * @name isSameWeek
+ * @category Week Helpers
+ * @summary Are the given dates in the same week?
+ *
+ * @description
+ * Are the given dates in the same week?
+ *
+ * ### 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
+ * @param {Object} [options] - an object with options.
+ * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
+ * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
+ * @returns {Boolean} the dates are in the same week
+ * @throws {TypeError} 2 arguments required
+ * @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
+ *
+ * @example
+ * // Are 31 August 2014 and 4 September 2014 in the same week?
+ * var result = isSameWeek(new Date(2014, 7, 31), new Date(2014, 8, 4))
+ * //=> true
+ *
+ * @example
+ * // If week starts with Monday,
+ * // are 31 August 2014 and 4 September 2014 in the same week?
+ * var result = isSameWeek(new Date(2014, 7, 31), new Date(2014, 8, 4), {
+ * weekStartsOn: 1
+ * })
+ * //=> false
+ */
+export default function isSameWeek(
+ dirtyDateLeft: Date | number,
+ dirtyDateRight: Date | number,
+ dirtyOptions?: LocaleOptions & WeekStartOptions
+): boolean {
+ requiredArgs(2, arguments)
+
+ const dateLeftStartOfWeek = startOfWeek(dirtyDateLeft, dirtyOptions)
+ const dateRightStartOfWeek = startOfWeek(dirtyDateRight, dirtyOptions)
+
+ return dateLeftStartOfWeek.getTime() === dateRightStartOfWeek.getTime()
+}