subMilliseconds.d.cts 1.0 KB

1234567891011121314151617181920212223242526
  1. import type { ContextOptions, DateArg } from "./types.js";
  2. /**
  3. * The {@link subMilliseconds} function options.
  4. */
  5. export interface SubMillisecondsOptions<DateType extends Date = Date>
  6. extends ContextOptions<DateType> {}
  7. /**
  8. * Subtract the specified number of milliseconds from the given date.
  9. *
  10. * @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).
  11. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  12. *
  13. * @param date - The date to be changed
  14. * @param amount - The amount of milliseconds to be subtracted.
  15. * @param options - An object with options
  16. *
  17. * @returns The new date with the milliseconds subtracted
  18. */
  19. export declare function subMilliseconds<
  20. DateType extends Date,
  21. ResultDate extends Date = DateType,
  22. >(
  23. date: DateArg<DateType>,
  24. amount: number,
  25. options?: SubMillisecondsOptions<ResultDate> | undefined,
  26. ): ResultDate;