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

25 lines
894 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name differenceInMonths
* @category Month Helpers
* @summary Get the number of full months between the given dates.
*
* @description
* Get the number of full months between the given dates using trunc as a default rounding method.
*
* @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 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<DateType extends Date>(
dateLeft: DateType | number | string,
dateRight: DateType | number | string,
): number;