timepiece/node_modules/date-fns/differenceInCalendarWeeks.mjs

60 lines
2.0 KiB
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { millisecondsInWeek } from "./constants.mjs";
import { startOfWeek } from "./startOfWeek.mjs";
import { getTimezoneOffsetInMilliseconds } from "./_lib/getTimezoneOffsetInMilliseconds.mjs";
/**
* 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
*/
export function differenceInCalendarWeeks(dateLeft, dateRight, options) {
const startOfWeekLeft = startOfWeek(dateLeft, options);
const startOfWeekRight = startOfWeek(dateRight, options);
const timestampLeft =
+startOfWeekLeft - getTimezoneOffsetInMilliseconds(startOfWeekLeft);
const timestampRight =
+startOfWeekRight - 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) / millisecondsInWeek);
}
// Fallback for modularized imports:
export default differenceInCalendarWeeks;