isSameISOWeek.js 1.1 KB

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