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