12345678910111213141516171819202122232425262728 |
- import endOfWeek from "../endOfWeek/index.js";
- import requiredArgs from "../_lib/requiredArgs/index.js";
- /**
- * @name endOfISOWeek
- * @category ISO Week Helpers
- * @summary Return the end of an ISO week for the given date.
- *
- * @description
- * Return the end of an ISO week for the given date.
- * The result will be in the local timezone.
- *
- * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
- *
- * @param {Date|Number} date - the original date
- * @returns {Date} the end of an ISO week
- * @throws {TypeError} 1 argument required
- *
- * @example
- * // The end of an ISO week for 2 September 2014 11:55:00:
- * const result = endOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
- * //=> Sun Sep 07 2014 23:59:59.999
- */
- export default function endOfISOWeek(dirtyDate) {
- requiredArgs(1, arguments);
- return endOfWeek(dirtyDate, {
- weekStartsOn: 1
- });
- }
|