| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 |
- import { toDate } from "./toDate.mjs";
- import { getDefaultOptions } from "./_lib/defaultOptions.mjs";
- /**
- * The {@link endOfWeek} function options.
- */
- /**
- * @name endOfWeek
- * @category Week Helpers
- * @summary Return the end of a week for the given date.
- *
- * @description
- * Return the end of a week for the given date.
- * The result will be in the local timezone.
- *
- * @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 original date
- * @param options - An object with options
- *
- * @returns The end of a week
- *
- * @example
- * // The end of a week for 2 September 2014 11:55:00:
- * const result = endOfWeek(new Date(2014, 8, 2, 11, 55, 0))
- * //=> Sat Sep 06 2014 23:59:59.999
- *
- * @example
- * // If the week starts on Monday, the end of the week for 2 September 2014 11:55:00:
- * const result = endOfWeek(new Date(2014, 8, 2, 11, 55, 0), { weekStartsOn: 1 })
- * //=> Sun Sep 07 2014 23:59:59.999
- */
- export function endOfWeek(date, options) {
- const defaultOptions = getDefaultOptions();
- const weekStartsOn =
- options?.weekStartsOn ??
- options?.locale?.options?.weekStartsOn ??
- defaultOptions.weekStartsOn ??
- defaultOptions.locale?.options?.weekStartsOn ??
- 0;
- const _date = toDate(date);
- const day = _date.getDay();
- const diff = (day < weekStartsOn ? -7 : 0) + 6 - (day - weekStartsOn);
- _date.setDate(_date.getDate() + diff);
- _date.setHours(23, 59, 59, 999);
- return _date;
- }
- // Fallback for modularized imports:
- export default endOfWeek;
|