getWeekYear.mjs 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. import { constructFrom } from "./constructFrom.mjs";
  2. import { startOfWeek } from "./startOfWeek.mjs";
  3. import { toDate } from "./toDate.mjs";
  4. import { getDefaultOptions } from "./_lib/defaultOptions.mjs";
  5. /**
  6. * The {@link getWeekYear} function options.
  7. */
  8. /**
  9. * @name getWeekYear
  10. * @category Week-Numbering Year Helpers
  11. * @summary Get the local week-numbering year of the given date.
  12. *
  13. * @description
  14. * Get the local week-numbering year of the given date.
  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#The_ISO_week_date_system
  21. *
  22. * @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).
  23. *
  24. * @param date - The given date
  25. * @param options - An object with options.
  26. *
  27. * @returns The local week-numbering year
  28. *
  29. * @example
  30. * // Which week numbering year is 26 December 2004 with the default settings?
  31. * const result = getWeekYear(new Date(2004, 11, 26))
  32. * //=> 2005
  33. *
  34. * @example
  35. * // Which week numbering year is 26 December 2004 if week starts on Saturday?
  36. * const result = getWeekYear(new Date(2004, 11, 26), { weekStartsOn: 6 })
  37. * //=> 2004
  38. *
  39. * @example
  40. * // Which week numbering year is 26 December 2004 if the first week contains 4 January?
  41. * const result = getWeekYear(new Date(2004, 11, 26), { firstWeekContainsDate: 4 })
  42. * //=> 2004
  43. */
  44. export function getWeekYear(date, options) {
  45. const _date = toDate(date);
  46. const year = _date.getFullYear();
  47. const defaultOptions = getDefaultOptions();
  48. const firstWeekContainsDate =
  49. options?.firstWeekContainsDate ??
  50. options?.locale?.options?.firstWeekContainsDate ??
  51. defaultOptions.firstWeekContainsDate ??
  52. defaultOptions.locale?.options?.firstWeekContainsDate ??
  53. 1;
  54. const firstWeekOfNextYear = constructFrom(date, 0);
  55. firstWeekOfNextYear.setFullYear(year + 1, 0, firstWeekContainsDate);
  56. firstWeekOfNextYear.setHours(0, 0, 0, 0);
  57. const startOfNextYear = startOfWeek(firstWeekOfNextYear, options);
  58. const firstWeekOfThisYear = constructFrom(date, 0);
  59. firstWeekOfThisYear.setFullYear(year, 0, firstWeekContainsDate);
  60. firstWeekOfThisYear.setHours(0, 0, 0, 0);
  61. const startOfThisYear = startOfWeek(firstWeekOfThisYear, options);
  62. if (_date.getTime() >= startOfNextYear.getTime()) {
  63. return year + 1;
  64. } else if (_date.getTime() >= startOfThisYear.getTime()) {
  65. return year;
  66. } else {
  67. return year - 1;
  68. }
  69. }
  70. // Fallback for modularized imports:
  71. export default getWeekYear;