50 lines
2.9 KiB
JavaScript
50 lines
2.9 KiB
JavaScript
|
import toDate from "../toDate/index.js";
|
||
|
|
import toInteger from "../_lib/toInteger/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
import { getDefaultOptions } from "../_lib/defaultOptions/index.js";
|
||
|
|
/**
|
||
|
|
* @name lastDayOfWeek
|
||
|
|
* @category Week Helpers
|
||
|
|
* @summary Return the last day of a week for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the last day of a week for the given date.
|
||
|
|
* The result will be in the local timezone.
|
||
|
|
*
|
||
|
|
* @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 last day of a week
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
* @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The last day of a week for 2 September 2014 11:55:00:
|
||
|
|
* const result = lastDayOfWeek(new Date(2014, 8, 2, 11, 55, 0))
|
||
|
|
* //=> Sat Sep 06 2014 00:00:00
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If the week starts on Monday, the last day of the week for 2 September 2014 11:55:00:
|
||
|
|
* const result = lastDayOfWeek(new Date(2014, 8, 2, 11, 55, 0), { weekStartsOn: 1 })
|
||
|
|
* //=> Sun Sep 07 2014 00:00:00
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function lastDayOfWeek(dirtyDate, options) {
|
||
|
|
var _ref, _ref2, _ref3, _options$weekStartsOn, _options$locale, _options$locale$optio, _defaultOptions$local, _defaultOptions$local2;
|
||
|
|
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
var defaultOptions = getDefaultOptions();
|
||
|
|
var weekStartsOn = toInteger((_ref = (_ref2 = (_ref3 = (_options$weekStartsOn = options === null || options === void 0 ? void 0 : options.weekStartsOn) !== null && _options$weekStartsOn !== void 0 ? _options$weekStartsOn : options === null || options === void 0 ? void 0 : (_options$locale = options.locale) === null || _options$locale === void 0 ? void 0 : (_options$locale$optio = _options$locale.options) === null || _options$locale$optio === void 0 ? void 0 : _options$locale$optio.weekStartsOn) !== null && _ref3 !== void 0 ? _ref3 : defaultOptions.weekStartsOn) !== null && _ref2 !== void 0 ? _ref2 : (_defaultOptions$local = defaultOptions.locale) === null || _defaultOptions$local === void 0 ? void 0 : (_defaultOptions$local2 = _defaultOptions$local.options) === null || _defaultOptions$local2 === void 0 ? void 0 : _defaultOptions$local2.weekStartsOn) !== null && _ref !== void 0 ? _ref : 0); // 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');
|
||
|
|
}
|
||
|
|
|
||
|
|
var date = toDate(dirtyDate);
|
||
|
|
var day = date.getDay();
|
||
|
|
var diff = (day < weekStartsOn ? -7 : 0) + 6 - (day - weekStartsOn);
|
||
|
|
date.setHours(0, 0, 0, 0);
|
||
|
|
date.setDate(date.getDate() + diff);
|
||
|
|
return date;
|
||
|
|
}
|