UNPKG

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