You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
2.2 KiB
54 lines
2.2 KiB
3 years ago
|
import toDate from '../toDate/index.js';
|
||
|
|
import toInteger from '../_lib/toInteger/index.js';
|
||
|
|
import requiredArgs from '../_lib/requiredArgs/index.js';
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
*
|
||
|
|
* ### v2.0.0 breaking changes:
|
||
|
|
*
|
||
|
|
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the original date
|
||
|
|
* @param {Object} [options] - an object with options.
|
||
|
|
* @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
|
||
|
|
* @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
|
||
|
|
* @returns {Date} the end of a week
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
* @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The end of a week for 2 September 2014 11:55:00:
|
||
|
|
* var 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:
|
||
|
|
* var result = endOfWeek(new Date(2014, 8, 2, 11, 55, 0), { weekStartsOn: 1 })
|
||
|
|
* //=> Sun Sep 07 2014 23:59:59.999
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function endOfWeek(dirtyDate, dirtyOptions) {
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
var options = dirtyOptions || {};
|
||
|
|
var locale = options.locale;
|
||
|
|
var localeWeekStartsOn = locale && locale.options && locale.options.weekStartsOn;
|
||
|
|
var defaultWeekStartsOn = localeWeekStartsOn == null ? 0 : toInteger(localeWeekStartsOn);
|
||
|
|
var weekStartsOn = options.weekStartsOn == null ? defaultWeekStartsOn : toInteger(options.weekStartsOn); // Test if weekStartsOn is between 0 and 6 _and_ is not NaN
|
||
|
|
|
||
|
|
if (!(weekStartsOn >= 0 && weekStartsOn <= 6)) {
|
||
|
|
throw new RangeError('weekStartsOn must be between 0 and 6 inclusively');
|
||
|
|
}
|
||
|
|
|
||
|
|
var date = toDate(dirtyDate);
|
||
|
|
var day = date.getDay();
|
||
|
|
var diff = (day < weekStartsOn ? -7 : 0) + 6 - (day - weekStartsOn);
|
||
|
|
date.setDate(date.getDate() + diff);
|
||
|
|
date.setHours(23, 59, 59, 999);
|
||
|
|
return date;
|
||
|
|
}
|