34 lines
1,005 B
TypeScript
34 lines
1,005 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link differenceInCalendarMonths} function options.
|
||
|
|
*/
|
||
|
|
export interface DifferenceInCalendarMonthsOptions
|
||
|
|
extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name differenceInCalendarMonths
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Get the number of calendar months between the given dates.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of calendar months between the given dates.
|
||
|
|
*
|
||
|
|
* @param laterDate - The later date
|
||
|
|
* @param earlierDate - The earlier date
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The number of calendar months
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many calendar months are between 31 January 2014 and 1 September 2014?
|
||
|
|
* const result = differenceInCalendarMonths(
|
||
|
|
* new Date(2014, 8, 1),
|
||
|
|
* new Date(2014, 0, 31)
|
||
|
|
* )
|
||
|
|
* //=> 8
|
||
|
|
*/
|
||
|
|
export declare function differenceInCalendarMonths(
|
||
|
|
laterDate: DateArg<Date> & {},
|
||
|
|
earlierDate: DateArg<Date> & {},
|
||
|
|
options?: DifferenceInCalendarMonthsOptions | undefined,
|
||
|
|
): number;
|