subWeeks.js 855 B

123456789101112131415161718192021222324252627
  1. "use strict";
  2. exports.subWeeks = subWeeks;
  3. var _index = require("./addWeeks.js");
  4. /**
  5. * @name subWeeks
  6. * @category Week Helpers
  7. * @summary Subtract the specified number of weeks from the given date.
  8. *
  9. * @description
  10. * Subtract the specified number of weeks from the given date.
  11. *
  12. * @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).
  13. *
  14. * @param date - The date to be changed
  15. * @param amount - The amount of weeks to be subtracted.
  16. *
  17. * @returns The new date with the weeks subtracted
  18. *
  19. * @example
  20. * // Subtract 4 weeks from 1 September 2014:
  21. * const result = subWeeks(new Date(2014, 8, 1), 4)
  22. * //=> Mon Aug 04 2014 00:00:00
  23. */
  24. function subWeeks(date, amount) {
  25. return (0, _index.addWeeks)(date, -amount);
  26. }