1234567891011121314151617181920212223242526272829303132333435363738 |
- "use strict";
- exports.addHours = addHours;
- var _index = require("./addMilliseconds.cjs");
- var _index2 = require("./constants.cjs");
- /**
- * The {@link addHours} function options.
- */
- /**
- * @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).
- * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
- *
- * @param date - The date to be changed
- * @param amount - The amount of hours to be added
- * @param options - An object with options
- *
- * @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
- */
- function addHours(date, amount, options) {
- return (0, _index.addMilliseconds)(
- date,
- amount * _index2.millisecondsInHour,
- options,
- );
- }
|