12345678910111213141516171819202122232425262728293031323334 |
- import { addHours } from "./addHours.js";
- /**
- * The {@link subHours} function options.
- */
- /**
- * @name subHours
- * @category Hour Helpers
- * @summary Subtract the specified number of hours from the given date.
- *
- * @description
- * Subtract the specified number of hours from 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 subtracted.
- * @param options - The options
- *
- * @returns The new date with the hours subtracted
- *
- * @example
- * // Subtract 2 hours from 11 July 2014 01:00:00:
- * const result = subHours(new Date(2014, 6, 11, 1, 0), 2)
- * //=> Thu Jul 10 2014 23:00:00
- */
- export function subHours(date, amount, options) {
- return addHours(date, -amount, options);
- }
- // Fallback for modularized imports:
- export default subHours;
|