subMilliseconds.d.ts 910 B

123456789101112131415161718192021222324
  1. /**
  2. * @name subMilliseconds
  3. * @category Millisecond Helpers
  4. * @summary Subtract the specified number of milliseconds from the given date.
  5. *
  6. * @description
  7. * Subtract the specified number of milliseconds from 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 amount - The amount of milliseconds to be subtracted.
  13. *
  14. * @returns The new date with the milliseconds subtracted
  15. *
  16. * @example
  17. * // Subtract 750 milliseconds from 10 July 2014 12:45:30.000:
  18. * const result = subMilliseconds(new Date(2014, 6, 10, 12, 45, 30, 0), 750)
  19. * //=> Thu Jul 10 2014 12:45:29.250
  20. */
  21. export declare function subMilliseconds<DateType extends Date>(
  22. date: DateType | number | string,
  23. amount: number,
  24. ): DateType;