index.js 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. import differenceInCalendarDays from "../differenceInCalendarDays/index.js";
  2. import startOfWeekYear from "../startOfWeekYear/index.js";
  3. import toDate from "../toDate/index.js";
  4. import toInteger from "../_lib/toInteger/index.js";
  5. import requiredArgs from "../_lib/requiredArgs/index.js";
  6. import { getDefaultOptions } from "../_lib/defaultOptions/index.js";
  7. /**
  8. * @name setWeekYear
  9. * @category Week-Numbering Year Helpers
  10. * @summary Set the local week-numbering year to the given date.
  11. *
  12. * @description
  13. * Set the local week-numbering year to the given date,
  14. * saving the week number and the weekday number.
  15. * The exact calculation depends on the values of
  16. * `options.weekStartsOn` (which is the index of the first day of the week)
  17. * and `options.firstWeekContainsDate` (which is the day of January, which is always in
  18. * the first week of the week-numbering year)
  19. *
  20. * Week numbering: https://en.wikipedia.org/wiki/Week#Week_numbering
  21. *
  22. * @param {Date|Number} date - the date to be changed
  23. * @param {Number} weekYear - the local week-numbering year of the new date
  24. * @param {Object} [options] - an object with options.
  25. * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
  26. * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
  27. * @param {1|2|3|4|5|6|7} [options.firstWeekContainsDate=1] - the day of January, which is always in the first week of the year
  28. * @returns {Date} the new date with the local week-numbering year set
  29. * @throws {TypeError} 2 arguments required
  30. * @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
  31. * @throws {RangeError} `options.firstWeekContainsDate` must be between 1 and 7
  32. *
  33. * @example
  34. * // Set the local week-numbering year 2004 to 2 January 2010 with default options:
  35. * const result = setWeekYear(new Date(2010, 0, 2), 2004)
  36. * //=> Sat Jan 03 2004 00:00:00
  37. *
  38. * @example
  39. * // Set the local week-numbering year 2004 to 2 January 2010,
  40. * // if Monday is the first day of week
  41. * // and 4 January is always in the first week of the year:
  42. * const result = setWeekYear(new Date(2010, 0, 2), 2004, {
  43. * weekStartsOn: 1,
  44. * firstWeekContainsDate: 4
  45. * })
  46. * //=> Sat Jan 01 2005 00:00:00
  47. */
  48. export default function setWeekYear(dirtyDate, dirtyWeekYear, options) {
  49. var _ref, _ref2, _ref3, _options$firstWeekCon, _options$locale, _options$locale$optio, _defaultOptions$local, _defaultOptions$local2;
  50. requiredArgs(2, arguments);
  51. var defaultOptions = getDefaultOptions();
  52. var firstWeekContainsDate = toInteger((_ref = (_ref2 = (_ref3 = (_options$firstWeekCon = options === null || options === void 0 ? void 0 : options.firstWeekContainsDate) !== null && _options$firstWeekCon !== void 0 ? _options$firstWeekCon : options === null || options === void 0 ? void 0 : (_options$locale = options.locale) === null || _options$locale === void 0 ? void 0 : (_options$locale$optio = _options$locale.options) === null || _options$locale$optio === void 0 ? void 0 : _options$locale$optio.firstWeekContainsDate) !== null && _ref3 !== void 0 ? _ref3 : defaultOptions.firstWeekContainsDate) !== null && _ref2 !== void 0 ? _ref2 : (_defaultOptions$local = defaultOptions.locale) === null || _defaultOptions$local === void 0 ? void 0 : (_defaultOptions$local2 = _defaultOptions$local.options) === null || _defaultOptions$local2 === void 0 ? void 0 : _defaultOptions$local2.firstWeekContainsDate) !== null && _ref !== void 0 ? _ref : 1);
  53. var date = toDate(dirtyDate);
  54. var weekYear = toInteger(dirtyWeekYear);
  55. var diff = differenceInCalendarDays(date, startOfWeekYear(date, options));
  56. var firstWeek = new Date(0);
  57. firstWeek.setFullYear(weekYear, 0, firstWeekContainsDate);
  58. firstWeek.setHours(0, 0, 0, 0);
  59. date = startOfWeekYear(firstWeek, options);
  60. date.setDate(date.getDate() + diff);
  61. return date;
  62. }