subMilliseconds.js 979 B

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