timepiece/node_modules/date-fns/subMilliseconds.mjs

29 lines
998 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { addMilliseconds } from "./addMilliseconds.mjs";
/**
* @name subMilliseconds
* @category Millisecond Helpers
* @summary Subtract the specified number of milliseconds from the given date.
*
* @description
* Subtract the specified number of milliseconds from 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 subtracted.
*
* @returns The new date with the milliseconds subtracted
*
* @example
* // Subtract 750 milliseconds from 10 July 2014 12:45:30.000:
* const result = subMilliseconds(new Date(2014, 6, 10, 12, 45, 30, 0), 750)
* //=> Thu Jul 10 2014 12:45:29.250
*/
export function subMilliseconds(date, amount) {
return addMilliseconds(date, -amount);
}
// Fallback for modularized imports:
export default subMilliseconds;