1234567891011121314151617181920212223242526272829 |
- 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());
- }
|