1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 |
- "use strict";
- exports.getWeek = getWeek;
- var _index = require("./constants.cjs");
- var _index2 = require("./startOfWeek.cjs");
- var _index3 = require("./startOfWeekYear.cjs");
- var _index4 = require("./toDate.cjs");
- /**
- * The {@link getWeek} function options.
- */
- /**
- * @name getWeek
- * @category Week Helpers
- * @summary Get the local week index of the given date.
- *
- * @description
- * Get the local week index of the given date.
- * The exact calculation depends on the values of
- * `options.weekStartsOn` (which is the index of the first day of the week)
- * and `options.firstWeekContainsDate` (which is the day of January, which is always in
- * the first week of the week-numbering year)
- *
- * Week numbering: https://en.wikipedia.org/wiki/Week#The_ISO_week_date_system
- *
- * @param date - The given date
- * @param options - An object with options
- *
- * @returns The week
- *
- * @example
- * // Which week of the local week numbering year is 2 January 2005 with default options?
- * const result = getWeek(new Date(2005, 0, 2))
- * //=> 2
- *
- * @example
- * // Which week of the local week numbering year is 2 January 2005,
- * // if Monday is the first day of the week,
- * // and the first week of the year always contains 4 January?
- * const result = getWeek(new Date(2005, 0, 2), {
- * weekStartsOn: 1,
- * firstWeekContainsDate: 4
- * })
- * //=> 53
- */
- function getWeek(date, options) {
- const _date = (0, _index4.toDate)(date, options?.in);
- const diff =
- +(0, _index2.startOfWeek)(_date, options) -
- +(0, _index3.startOfWeekYear)(_date, options);
- // Round the number of weeks to the nearest integer because the number of
- // milliseconds in a week is not constant (e.g. it's different in the week of
- // the daylight saving time clock shift).
- return Math.round(diff / _index.millisecondsInWeek) + 1;
- }
|