addWeeks.mjs 863 B

1234567891011121314151617181920212223242526272829
  1. import { addDays } from "./addDays.mjs";
  2. /**
  3. * @name addWeeks
  4. * @category Week Helpers
  5. * @summary Add the specified number of weeks to the given date.
  6. *
  7. * @description
  8. * Add the specified number of week to the given date.
  9. *
  10. * @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).
  11. *
  12. * @param date - The date to be changed
  13. * @param amount - The amount of weeks to be added.
  14. *
  15. * @returns The new date with the weeks added
  16. *
  17. * @example
  18. * // Add 4 weeks to 1 September 2014:
  19. * const result = addWeeks(new Date(2014, 8, 1), 4)
  20. * //=> Mon Sep 29 2014 00:00:00
  21. */
  22. export function addWeeks(date, amount) {
  23. const days = amount * 7;
  24. return addDays(date, days);
  25. }
  26. // Fallback for modularized imports:
  27. export default addWeeks;