UNPKG

974 BTypeScriptView Raw
1import type { ContextOptions, DateArg, RoundingOptions } from "./types.js";
2/**
3 * The {@link differenceInQuarters} function options.
4 */
5export interface DifferenceInQuartersOptions
6 extends RoundingOptions,
7 ContextOptions<Date> {}
8/**
9 * @name differenceInQuarters
10 * @category Quarter Helpers
11 * @summary Get the number of quarters between the given dates.
12 *
13 * @description
14 * Get the number of quarters between the given dates.
15 *
16 * @param laterDate - The later date
17 * @param earlierDate - The earlier date
18 * @param options - An object with options.
19 *
20 * @returns The number of full quarters
21 *
22 * @example
23 * // How many full quarters are between 31 December 2013 and 2 July 2014?
24 * const result = differenceInQuarters(new Date(2014, 6, 2), new Date(2013, 11, 31))
25 * //=> 2
26 */
27export declare function differenceInQuarters(
28 laterDate: DateArg<Date> & {},
29 earlierDate: DateArg<Date> & {},
30 options?: DifferenceInQuartersOptions | undefined,
31): number;