aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/isThisISOWeek/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/date-fns/esm/isThisISOWeek/index.js')
-rw-r--r--node_modules/date-fns/esm/isThisISOWeek/index.js29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/isThisISOWeek/index.js b/node_modules/date-fns/esm/isThisISOWeek/index.js
new file mode 100644
index 0000000..97bb427
--- /dev/null
+++ b/node_modules/date-fns/esm/isThisISOWeek/index.js
@@ -0,0 +1,29 @@
+import isSameISOWeek from "../isSameISOWeek/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+/**
+ * @name isThisISOWeek
+ * @category ISO Week Helpers
+ * @summary Is the given date in the same ISO week as the current date?
+ * @pure false
+ *
+ * @description
+ * Is the given date in the same ISO week as the current date?
+ *
+ * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
+ *
+ * > ⚠️ Please note that this function is not present in the FP submodule as
+ * > it uses `Date.now()` internally hence impure and can't be safely curried.
+ *
+ * @param {Date|Number} date - the date to check
+ * @returns {Boolean} the date is in this ISO week
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // If today is 25 September 2014, is 22 September 2014 in this ISO week?
+ * const result = isThisISOWeek(new Date(2014, 8, 22))
+ * //=> true
+ */
+export default function isThisISOWeek(dirtyDate) {
+ requiredArgs(1, arguments);
+ return isSameISOWeek(dirtyDate, Date.now());
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage