Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
36 lines
1.3 KiB
Plaintext
36 lines
1.3 KiB
Plaintext
import { constructFrom } from "./constructFrom.js";
|
|
import { toDate } from "./toDate.js";
|
|
|
|
/**
|
|
* The {@link addMilliseconds} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name addMilliseconds
|
|
* @category Millisecond Helpers
|
|
* @summary Add the specified number of milliseconds to the given date.
|
|
*
|
|
* @description
|
|
* Add the specified number of milliseconds to the given date.
|
|
*
|
|
* @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).
|
|
* @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
|
*
|
|
* @param date - The date to be changed
|
|
* @param amount - The amount of milliseconds to be added.
|
|
* @param options - The options object
|
|
*
|
|
* @returns The new date with the milliseconds added
|
|
*
|
|
* @example
|
|
* // Add 750 milliseconds to 10 July 2014 12:45:30.000:
|
|
* const result = addMilliseconds(new Date(2014, 6, 10, 12, 45, 30, 0), 750)
|
|
* //=> Thu Jul 10 2014 12:45:30.750
|
|
*/
|
|
export function addMilliseconds(date, amount, options) {
|
|
return constructFrom(options?.in || date, +toDate(date) + amount);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default addMilliseconds;
|