timepiece/node_modules/date-fns/isThisISOWeek.mjs

33 lines
993 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { constructNow } from "./constructNow.mjs";
import { isSameISOWeek } from "./isSameISOWeek.mjs";
/**
* @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
*
* @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 date - The date to check
*
* @returns The date is in this ISO week
*
* @example
* // If today is 25 September 2014, is 22 September 2014 in this ISO week?
* const result = isThisISOWeek(new Date(2014, 8, 22))
* //=> true
*/
export function isThisISOWeek(date) {
return isSameISOWeek(date, constructNow(date));
}
// Fallback for modularized imports:
export default isThisISOWeek;