setMilliseconds.d.ts 847 B

123456789101112131415161718192021222324
  1. /**
  2. * @name setMilliseconds
  3. * @category Millisecond Helpers
  4. * @summary Set the milliseconds to the given date.
  5. *
  6. * @description
  7. * Set the milliseconds to the given date.
  8. *
  9. * @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).
  10. *
  11. * @param date - The date to be changed
  12. * @param milliseconds - The milliseconds of the new date
  13. *
  14. * @returns The new date with the milliseconds set
  15. *
  16. * @example
  17. * // Set 300 milliseconds to 1 September 2014 11:30:40.500:
  18. * const result = setMilliseconds(new Date(2014, 8, 1, 11, 30, 40, 500), 300)
  19. * //=> Mon Sep 01 2014 11:30:40.300
  20. */
  21. export declare function setMilliseconds<DateType extends Date>(
  22. date: DateType | number | string,
  23. milliseconds: number,
  24. ): DateType;