27 lines
1014 B
JavaScript
27 lines
1014 B
JavaScript
import toInteger from "../_lib/toInteger/index.js";
|
|
import addWeeks from "../addWeeks/index.js";
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
|
/**
|
|
* @name subWeeks
|
|
* @category Week Helpers
|
|
* @summary Subtract the specified number of weeks from the given date.
|
|
*
|
|
* @description
|
|
* Subtract the specified number of weeks from the given date.
|
|
*
|
|
* @param {Date|Number} date - the date to be changed
|
|
* @param {Number} amount - the amount of weeks 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 weeks subtracted
|
|
* @throws {TypeError} 2 arguments required
|
|
*
|
|
* @example
|
|
* // Subtract 4 weeks from 1 September 2014:
|
|
* const result = subWeeks(new Date(2014, 8, 1), 4)
|
|
* //=> Mon Aug 04 2014 00:00:00
|
|
*/
|
|
|
|
export default function subWeeks(dirtyDate, dirtyAmount) {
|
|
requiredArgs(2, arguments);
|
|
var amount = toInteger(dirtyAmount);
|
|
return addWeeks(dirtyDate, -amount);
|
|
} |