| 1234567891011121314151617181920212223242526272829 |
- import { addMilliseconds } from "./addMilliseconds.mjs";
- import { millisecondsInHour } from "./constants.mjs";
- /**
- * @name addHours
- * @category Hour Helpers
- * @summary Add the specified number of hours to the given date.
- *
- * @description
- * Add the specified number of hours to the given date.
- *
- * @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).
- *
- * @param date - The date to be changed
- * @param amount - The amount of hours to be added.
- *
- * @returns The new date with the hours added
- *
- * @example
- * // Add 2 hours to 10 July 2014 23:00:00:
- * const result = addHours(new Date(2014, 6, 10, 23, 0), 2)
- * //=> Fri Jul 11 2014 01:00:00
- */
- export function addHours(date, amount) {
- return addMilliseconds(date, amount * millisecondsInHour);
- }
- // Fallback for modularized imports:
- export default addHours;
|