differenceInCalendarMonths.d.ts 908 B

123456789101112131415161718192021222324252627
  1. /**
  2. * @name differenceInCalendarMonths
  3. * @category Month Helpers
  4. * @summary Get the number of calendar months between the given dates.
  5. *
  6. * @description
  7. * Get the number of calendar months between the given dates.
  8. *
  9. * @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).
  10. *
  11. * @param dateLeft - The later date
  12. * @param dateRight - The earlier date
  13. *
  14. * @returns The number of calendar months
  15. *
  16. * @example
  17. * // How many calendar months are between 31 January 2014 and 1 September 2014?
  18. * const result = differenceInCalendarMonths(
  19. * new Date(2014, 8, 1),
  20. * new Date(2014, 0, 31)
  21. * )
  22. * //=> 8
  23. */
  24. export declare function differenceInCalendarMonths<DateType extends Date>(
  25. dateLeft: DateType | number | string,
  26. dateRight: DateType | number | string,
  27. ): number;