34 lines
1.1 KiB
JavaScript
34 lines
1.1 KiB
JavaScript
|
import isSameWeek from "../isSameWeek/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
/**
|
||
|
|
* @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
|
||
|
|
*
|
||
|
|
* @param {Date|Number} dateLeft - the first date to check
|
||
|
|
* @param {Date|Number} dateRight - the second date to check
|
||
|
|
* @returns {Boolean} the dates are in the same ISO week (and year)
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @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 default function isSameISOWeek(dirtyDateLeft, dirtyDateRight) {
|
||
|
|
requiredArgs(2, arguments);
|
||
|
|
return isSameWeek(dirtyDateLeft, dirtyDateRight, {
|
||
|
|
weekStartsOn: 1
|
||
|
|
});
|
||
|
|
}
|