UNPKG

919 BTypeScriptView Raw
1/**
2 * @name differenceInCalendarQuarters
3 * @category Quarter Helpers
4 * @summary Get the number of calendar quarters between the given dates.
5 *
6 * @description
7 * Get the number of calendar quarters between the given dates.
8 *
9 * @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).
10 *
11 * @param dateLeft - The later date
12 * @param dateRight - The earlier date
13
14 * @returns The number of calendar quarters
15 *
16 * @example
17 * // How many calendar quarters are between 31 December 2013 and 2 July 2014?
18 * const result = differenceInCalendarQuarters(
19 * new Date(2014, 6, 2),
20 * new Date(2013, 11, 31)
21 * )
22 * //=> 3
23 */
24export declare function differenceInCalendarQuarters<DateType extends Date>(
25 dateLeft: DateType | number | string,
26 dateRight: DateType | number | string,
27): number;