isSameISOWeek.mjs 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  1. import { isSameWeek } from "./isSameWeek.mjs";
  2. /**
  3. * @name isSameISOWeek
  4. * @category ISO Week Helpers
  5. * @summary Are the given dates in the same ISO week (and year)?
  6. *
  7. * @description
  8. * Are the given dates in the same ISO week (and year)?
  9. *
  10. * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  11. *
  12. * @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).
  13. *
  14. * @param dateLeft - The first date to check
  15. * @param dateRight - The second date to check
  16. *
  17. * @returns The dates are in the same ISO week (and year)
  18. *
  19. * @example
  20. * // Are 1 September 2014 and 7 September 2014 in the same ISO week?
  21. * const result = isSameISOWeek(new Date(2014, 8, 1), new Date(2014, 8, 7))
  22. * //=> true
  23. *
  24. * @example
  25. * // Are 1 September 2014 and 1 September 2015 in the same ISO week?
  26. * const result = isSameISOWeek(new Date(2014, 8, 1), new Date(2015, 8, 1))
  27. * //=> false
  28. */
  29. export function isSameISOWeek(dateLeft, dateRight) {
  30. return isSameWeek(dateLeft, dateRight, { weekStartsOn: 1 });
  31. }
  32. // Fallback for modularized imports:
  33. export default isSameISOWeek;