47 lines
1.5 KiB
TypeScript
47 lines
1.5 KiB
TypeScript
|
import type { LocalizedOptions, WeekOptions } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link differenceInCalendarWeeks} function options.
|
||
|
|
*/
|
||
|
|
export interface DifferenceInCalendarWeeksOptions
|
||
|
|
extends LocalizedOptions<"options">,
|
||
|
|
WeekOptions {}
|
||
|
|
/**
|
||
|
|
* @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 declare function differenceInCalendarWeeks<DateType extends Date>(
|
||
|
|
dateLeft: DateType | number | string,
|
||
|
|
dateRight: DateType | number | string,
|
||
|
|
options?: DifferenceInCalendarWeeksOptions,
|
||
|
|
): number;
|