31 lines
1.0 KiB
JavaScript
31 lines
1.0 KiB
JavaScript
|
import { toDate } from "./toDate.mjs";
|
||
|
|
import { constructFrom } from "./constructFrom.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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).
|
||
|
|
*
|
||
|
|
* @param date - The date to be changed
|
||
|
|
* @param amount - The amount of milliseconds to be added.
|
||
|
|
*
|
||
|
|
* @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) {
|
||
|
|
const timestamp = +toDate(date);
|
||
|
|
return constructFrom(date, timestamp + amount);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default addMilliseconds;
|