subMonths.d.mts 822 B

123456789101112131415161718192021222324
  1. /**
  2. * @name subMonths
  3. * @category Month Helpers
  4. * @summary Subtract the specified number of months from the given date.
  5. *
  6. * @description
  7. * Subtract the specified number of months from the given date.
  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 date - The date to be changed
  12. * @param amount - The amount of months to be subtracted.
  13. *
  14. * @returns The new date with the months subtracted
  15. *
  16. * @example
  17. * // Subtract 5 months from 1 February 2015:
  18. * const result = subMonths(new Date(2015, 1, 1), 5)
  19. * //=> Mon Sep 01 2014 00:00:00
  20. */
  21. export declare function subMonths<DateType extends Date>(
  22. date: DateType | number | string,
  23. amount: number,
  24. ): DateType;