timepiece/node_modules/date-fns/differenceInCalendarQuarters.d.ts

28 lines
919 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name differenceInCalendarQuarters
* @category Quarter Helpers
* @summary Get the number of calendar quarters between the given dates.
*
* @description
* Get the number of calendar quarters 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
* @returns The number of calendar quarters
*
* @example
* // How many calendar quarters are between 31 December 2013 and 2 July 2014?
* const result = differenceInCalendarQuarters(
* new Date(2014, 6, 2),
* new Date(2013, 11, 31)
* )
* //=> 3
*/
export declare function differenceInCalendarQuarters<DateType extends Date>(
dateLeft: DateType | number | string,
dateRight: DateType | number | string,
): number;