27 lines
847 B
TypeScript
27 lines
847 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link differenceInMonths} function options.
|
||
|
|
*/
|
||
|
|
export interface DifferenceInMonthsOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name differenceInMonths
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Get the number of full 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 full months
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many full months are between 31 January 2014 and 1 September 2014?
|
||
|
|
* const result = differenceInMonths(new Date(2014, 8, 1), new Date(2014, 0, 31))
|
||
|
|
* //=> 7
|
||
|
|
*/
|
||
|
|
export declare function differenceInMonths(
|
||
|
|
laterDate: DateArg<Date> & {},
|
||
|
|
earlierDate: DateArg<Date> & {},
|
||
|
|
options?: DifferenceInMonthsOptions | undefined,
|
||
|
|
): number;
|