subHours.mjs 886 B

12345678910111213141516171819202122232425262728
  1. import { addHours } from "./addHours.mjs";
  2. /**
  3. * @name subHours
  4. * @category Hour Helpers
  5. * @summary Subtract the specified number of hours from the given date.
  6. *
  7. * @description
  8. * Subtract the specified number of hours from the given date.
  9. *
  10. * @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).
  11. *
  12. * @param date - The date to be changed
  13. * @param amount - The amount of hours to be subtracted.
  14. *
  15. * @returns The new date with the hours subtracted
  16. *
  17. * @example
  18. * // Subtract 2 hours from 11 July 2014 01:00:00:
  19. * const result = subHours(new Date(2014, 6, 11, 1, 0), 2)
  20. * //=> Thu Jul 10 2014 23:00:00
  21. */
  22. export function subHours(date, amount) {
  23. return addHours(date, -amount);
  24. }
  25. // Fallback for modularized imports:
  26. export default subHours;