30 lines
863 B
JavaScript
30 lines
863 B
JavaScript
|
import { addDays } from "./addDays.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
*
|
||
|
|
* @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 weeks to be added.
|
||
|
|
*
|
||
|
|
* @returns The new date with the weeks added
|
||
|
|
*
|
||
|
|
* @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 function addWeeks(date, amount) {
|
||
|
|
const days = amount * 7;
|
||
|
|
return addDays(date, days);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default addWeeks;
|