diff options
Diffstat (limited to 'date-fns/src/isThisISOWeek/index.ts')
-rw-r--r-- | date-fns/src/isThisISOWeek/index.ts | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/date-fns/src/isThisISOWeek/index.ts b/date-fns/src/isThisISOWeek/index.ts new file mode 100644 index 0000000..6841b50 --- /dev/null +++ b/date-fns/src/isThisISOWeek/index.ts @@ -0,0 +1,36 @@ +import isSameISOWeek from '../isSameISOWeek/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @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. + * + * ### 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} 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? + * var result = isThisISOWeek(new Date(2014, 8, 22)) + * //=> true + */ + +export default function isThisISOWeek(dirtyDate: Date | number): boolean { + requiredArgs(1, arguments) + + return isSameISOWeek(dirtyDate, Date.now()) +} |