addWeeks.d.ts 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. import type { ContextOptions, DateArg } from "./types.js";
  2. /**
  3. * The {@link addWeeks} function options.
  4. */
  5. export interface AddWeeksOptions<DateType extends Date = Date>
  6. extends ContextOptions<DateType> {}
  7. /**
  8. * @name addWeeks
  9. * @category Week Helpers
  10. * @summary Add the specified number of weeks to the given date.
  11. *
  12. * @description
  13. * Add the specified number of weeks to 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 weeks to be added.
  20. * @param options - An object with options
  21. *
  22. * @returns The new date with the weeks added
  23. *
  24. * @example
  25. * // Add 4 weeks to 1 September 2014:
  26. * const result = addWeeks(new Date(2014, 8, 1), 4)
  27. * //=> Mon Sep 29 2014 00:00:00
  28. */
  29. export declare function addWeeks<
  30. DateType extends Date,
  31. ResultDate extends Date = DateType,
  32. >(
  33. date: DateArg<DateType>,
  34. amount: number,
  35. options?: AddWeeksOptions<ResultDate> | undefined,
  36. ): ResultDate;