subMinutes.js 896 B

123456789101112131415161718192021222324252627
  1. "use strict";
  2. exports.subMinutes = subMinutes;
  3. var _index = require("./addMinutes.js");
  4. /**
  5. * @name subMinutes
  6. * @category Minute Helpers
  7. * @summary Subtract the specified number of minutes from the given date.
  8. *
  9. * @description
  10. * Subtract the specified number of minutes from the given date.
  11. *
  12. * @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).
  13. *
  14. * @param date - The date to be changed
  15. * @param amount - The amount of minutes to be subtracted.
  16. *
  17. * @returns The new date with the minutes subtracted
  18. *
  19. * @example
  20. * // Subtract 30 minutes from 10 July 2014 12:00:00:
  21. * const result = subMinutes(new Date(2014, 6, 10, 12, 0), 30)
  22. * //=> Thu Jul 10 2014 11:30:00
  23. */
  24. function subMinutes(date, amount) {
  25. return (0, _index.addMinutes)(date, -amount);
  26. }