| 1 | import { constructFrom } from "./constructFrom.js";
|
| 2 | import { toDate } from "./toDate.js";
|
| 3 |
|
| 4 | /**
|
| 5 | * The {@link addMilliseconds} function options.
|
| 6 | */
|
| 7 |
|
| 8 | /**
|
| 9 | * @name addMilliseconds
|
| 10 | * @category Millisecond Helpers
|
| 11 | * @summary Add the specified number of milliseconds to the given date.
|
| 12 | *
|
| 13 | * @description
|
| 14 | * Add the specified number of milliseconds to the given date.
|
| 15 | *
|
| 16 | * @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).
|
| 17 | * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
| 18 | *
|
| 19 | * @param date - The date to be changed
|
| 20 | * @param amount - The amount of milliseconds to be added.
|
| 21 | * @param options - The options object
|
| 22 | *
|
| 23 | * @returns The new date with the milliseconds added
|
| 24 | *
|
| 25 | * @example
|
| 26 | * // Add 750 milliseconds to 10 July 2014 12:45:30.000:
|
| 27 | * const result = addMilliseconds(new Date(2014, 6, 10, 12, 45, 30, 0), 750)
|
| 28 | * //=> Thu Jul 10 2014 12:45:30.750
|
| 29 | */
|
| 30 | export function addMilliseconds(date, amount, options) {
|
| 31 | return constructFrom(options?.in || date, +toDate(date) + amount);
|
| 32 | }
|
| 33 |
|
| 34 | // Fallback for modularized imports:
|
| 35 | export default addMilliseconds;
|