27 lines
1.1 KiB
JavaScript
27 lines
1.1 KiB
JavaScript
|
import addMilliseconds from "../addMilliseconds/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
import toInteger from "../_lib/toInteger/index.js";
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the date to be changed
|
||
|
|
* @param {Number} amount - the amount of milliseconds to be subtracted. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
|
||
|
|
* @returns {Date} the new date with the milliseconds subtracted
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @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 default function subMilliseconds(dirtyDate, dirtyAmount) {
|
||
|
|
requiredArgs(2, arguments);
|
||
|
|
var amount = toInteger(dirtyAmount);
|
||
|
|
return addMilliseconds(dirtyDate, -amount);
|
||
|
|
}
|