setMilliseconds.cjs 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  1. "use strict";
  2. exports.setMilliseconds = setMilliseconds;
  3. var _index = require("./toDate.cjs");
  4. /**
  5. * The {@link setMilliseconds} function options.
  6. */
  7. /**
  8. * @name setMilliseconds
  9. * @category Millisecond Helpers
  10. * @summary Set the milliseconds to the given date.
  11. *
  12. * @description
  13. * Set the milliseconds to the given date.
  14. *
  15. * @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).
  16. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  17. *
  18. * @param date - The date to be changed
  19. * @param milliseconds - The milliseconds of the new date
  20. * @param options - The options
  21. *
  22. * @returns The new date with the milliseconds set
  23. *
  24. * @example
  25. * // Set 300 milliseconds to 1 September 2014 11:30:40.500:
  26. * const result = setMilliseconds(new Date(2014, 8, 1, 11, 30, 40, 500), 300)
  27. * //=> Mon Sep 01 2014 11:30:40.300
  28. */
  29. function setMilliseconds(date, milliseconds, options) {
  30. const _date = (0, _index.toDate)(date, options?.in);
  31. _date.setMilliseconds(milliseconds);
  32. return _date;
  33. }