addHours.d.ts 796 B

123456789101112131415161718192021222324
  1. /**
  2. * @name addHours
  3. * @category Hour Helpers
  4. * @summary Add the specified number of hours to the given date.
  5. *
  6. * @description
  7. * Add the specified number of hours to 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 hours to be added.
  13. *
  14. * @returns The new date with the hours added
  15. *
  16. * @example
  17. * // Add 2 hours to 10 July 2014 23:00:00:
  18. * const result = addHours(new Date(2014, 6, 10, 23, 0), 2)
  19. * //=> Fri Jul 11 2014 01:00:00
  20. */
  21. export declare function addHours<DateType extends Date>(
  22. date: DateType | number | string,
  23. amount: number,
  24. ): DateType;