64 lines
2.0 KiB
JavaScript
64 lines
2.0 KiB
JavaScript
"use strict";
|
|
exports.differenceInCalendarWeeks = differenceInCalendarWeeks;
|
|
var _index = require("./constants.js");
|
|
var _index2 = require("./startOfWeek.js");
|
|
|
|
var _index3 = require("./_lib/getTimezoneOffsetInMilliseconds.js");
|
|
|
|
/**
|
|
* The {@link differenceInCalendarWeeks} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name differenceInCalendarWeeks
|
|
* @category Week Helpers
|
|
* @summary Get the number of calendar weeks between the given dates.
|
|
*
|
|
* @description
|
|
* Get the number of calendar weeks between the given dates.
|
|
*
|
|
* @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 dateLeft - The later date
|
|
* @param dateRight - The earlier date
|
|
* @param options - An object with options.
|
|
*
|
|
* @returns The number of calendar weeks
|
|
*
|
|
* @example
|
|
* // How many calendar weeks are between 5 July 2014 and 20 July 2014?
|
|
* const result = differenceInCalendarWeeks(
|
|
* new Date(2014, 6, 20),
|
|
* new Date(2014, 6, 5)
|
|
* )
|
|
* //=> 3
|
|
*
|
|
* @example
|
|
* // If the week starts on Monday,
|
|
* // how many calendar weeks are between 5 July 2014 and 20 July 2014?
|
|
* const result = differenceInCalendarWeeks(
|
|
* new Date(2014, 6, 20),
|
|
* new Date(2014, 6, 5),
|
|
* { weekStartsOn: 1 }
|
|
* )
|
|
* //=> 2
|
|
*/
|
|
function differenceInCalendarWeeks(dateLeft, dateRight, options) {
|
|
const startOfWeekLeft = (0, _index2.startOfWeek)(dateLeft, options);
|
|
const startOfWeekRight = (0, _index2.startOfWeek)(dateRight, options);
|
|
|
|
const timestampLeft =
|
|
+startOfWeekLeft -
|
|
(0, _index3.getTimezoneOffsetInMilliseconds)(startOfWeekLeft);
|
|
const timestampRight =
|
|
+startOfWeekRight -
|
|
(0, _index3.getTimezoneOffsetInMilliseconds)(startOfWeekRight);
|
|
|
|
// Round the number of days to the nearest integer because the number of
|
|
// milliseconds in a days is not constant (e.g. it's different in the week of
|
|
// the daylight saving time clock shift).
|
|
return Math.round(
|
|
(timestampLeft - timestampRight) / _index.millisecondsInWeek,
|
|
);
|
|
}
|