| 1234567891011121314151617181920212223242526272829303132333435 |
- import { isSameWeek } from "./isSameWeek.mjs";
- /**
- * @name isSameISOWeek
- * @category ISO Week Helpers
- * @summary Are the given dates in the same ISO week (and year)?
- *
- * @description
- * Are the given dates in the same ISO week (and year)?
- *
- * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
- *
- * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
- *
- * @param dateLeft - The first date to check
- * @param dateRight - The second date to check
- *
- * @returns The dates are in the same ISO week (and year)
- *
- * @example
- * // Are 1 September 2014 and 7 September 2014 in the same ISO week?
- * const result = isSameISOWeek(new Date(2014, 8, 1), new Date(2014, 8, 7))
- * //=> true
- *
- * @example
- * // Are 1 September 2014 and 1 September 2015 in the same ISO week?
- * const result = isSameISOWeek(new Date(2014, 8, 1), new Date(2015, 8, 1))
- * //=> false
- */
- export function isSameISOWeek(dateLeft, dateRight) {
- return isSameWeek(dateLeft, dateRight, { weekStartsOn: 1 });
- }
- // Fallback for modularized imports:
- export default isSameISOWeek;
|