53 lines
1.6 KiB
JavaScript
53 lines
1.6 KiB
JavaScript
|
import { getDate } from "./getDate.mjs";
|
||
|
|
import { getDay } from "./getDay.mjs";
|
||
|
|
import { startOfMonth } from "./startOfMonth.mjs";
|
||
|
|
import { getDefaultOptions } from "./_lib/defaultOptions.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link getWeekOfMonth} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name getWeekOfMonth
|
||
|
|
* @category Week Helpers
|
||
|
|
* @summary Get the week of the month of the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the week of the month of the given date.
|
||
|
|
*
|
||
|
|
* @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).
|
||
|
|
*
|
||
|
|
* @param date - The given date
|
||
|
|
* @param options - An object with options.
|
||
|
|
*
|
||
|
|
* @returns The week of month
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Which week of the month is 9 November 2017?
|
||
|
|
* const result = getWeekOfMonth(new Date(2017, 10, 9))
|
||
|
|
* //=> 2
|
||
|
|
*/
|
||
|
|
export function getWeekOfMonth(date, options) {
|
||
|
|
const defaultOptions = getDefaultOptions();
|
||
|
|
const weekStartsOn =
|
||
|
|
options?.weekStartsOn ??
|
||
|
|
options?.locale?.options?.weekStartsOn ??
|
||
|
|
defaultOptions.weekStartsOn ??
|
||
|
|
defaultOptions.locale?.options?.weekStartsOn ??
|
||
|
|
0;
|
||
|
|
|
||
|
|
const currentDayOfMonth = getDate(date);
|
||
|
|
if (isNaN(currentDayOfMonth)) return NaN;
|
||
|
|
|
||
|
|
const startWeekDay = getDay(startOfMonth(date));
|
||
|
|
|
||
|
|
let lastDayOfFirstWeek = weekStartsOn - startWeekDay;
|
||
|
|
if (lastDayOfFirstWeek <= 0) lastDayOfFirstWeek += 7;
|
||
|
|
|
||
|
|
const remainingDaysAfterFirstWeek = currentDayOfMonth - lastDayOfFirstWeek;
|
||
|
|
return Math.ceil(remainingDaysAfterFirstWeek / 7) + 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default getWeekOfMonth;
|