timepiece/node_modules/date-fns/differenceInQuarters.d.mts

32 lines
1.1 KiB
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import type { RoundingOptions } from "./types.js";
/**
* The {@link differenceInQuarters} function options.
*/
export interface DifferenceInQuartersOptions extends RoundingOptions {}
/**
* @name differenceInQuarters
* @category Quarter Helpers
* @summary Get the number of quarters between the given dates.
*
* @description
* Get the number of 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
* @param options - An object with options.
*
* @returns The number of full quarters
*
* @example
* // How many full quarters are between 31 December 2013 and 2 July 2014?
* const result = differenceInQuarters(new Date(2014, 6, 2), new Date(2013, 11, 31))
* //=> 2
*/
export declare function differenceInQuarters<DateType extends Date>(
dateLeft: DateType | number | string,
dateRight: DateType | number | string,
options?: DifferenceInQuartersOptions,
): number;