subMonths.cjs 1.1 KB

123456789101112131415161718192021222324252627282930313233
  1. "use strict";
  2. exports.subMonths = subMonths;
  3. var _index = require("./addMonths.cjs");
  4. /**
  5. * The subMonths function options.
  6. */
  7. /**
  8. * @name subMonths
  9. * @category Month Helpers
  10. * @summary Subtract the specified number of months from the given date.
  11. *
  12. * @description
  13. * Subtract the specified number of months from the given date.
  14. *
  15. * @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).
  16. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  17. *
  18. * @param date - The date to be changed
  19. * @param amount - The amount of months to be subtracted.
  20. * @param options - An object with options
  21. *
  22. * @returns The new date with the months subtracted
  23. *
  24. * @example
  25. * // Subtract 5 months from 1 February 2015:
  26. * const result = subMonths(new Date(2015, 1, 1), 5)
  27. * //=> Mon Sep 01 2014 00:00:00
  28. */
  29. function subMonths(date, amount, options) {
  30. return (0, _index.addMonths)(date, -amount, options);
  31. }