aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/isSameWeek/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/date-fns/esm/isSameWeek/index.js')
-rw-r--r--node_modules/date-fns/esm/isSameWeek/index.js43
1 files changed, 43 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/isSameWeek/index.js b/node_modules/date-fns/esm/isSameWeek/index.js
new file mode 100644
index 0000000..3f3636c
--- /dev/null
+++ b/node_modules/date-fns/esm/isSameWeek/index.js
@@ -0,0 +1,43 @@
+import startOfWeek from "../startOfWeek/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+/**
+ * @name isSameWeek
+ * @category Week Helpers
+ * @summary Are the given dates in the same week (and month and year)?
+ *
+ * @description
+ * Are the given dates in the same week (and month and year)?
+ *
+ * @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 (and month and year)
+ * @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?
+ * const 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?
+ * const result = isSameWeek(new Date(2014, 7, 31), new Date(2014, 8, 4), {
+ * weekStartsOn: 1
+ * })
+ * //=> false
+ *
+ * @example
+ * // Are 1 January 2014 and 1 January 2015 in the same week?
+ * const result = isSameWeek(new Date(2014, 0, 1), new Date(2015, 0, 1))
+ * //=> false
+ */
+export default function isSameWeek(dirtyDateLeft, dirtyDateRight, options) {
+ requiredArgs(2, arguments);
+ var dateLeftStartOfWeek = startOfWeek(dirtyDateLeft, options);
+ var dateRightStartOfWeek = startOfWeek(dirtyDateRight, options);
+ return dateLeftStartOfWeek.getTime() === dateRightStartOfWeek.getTime();
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage