37 lines
1.1 KiB
JavaScript
37 lines
1.1 KiB
JavaScript
import { toDate } from "./toDate.mjs";
|
|
import { constructFrom } from "./constructFrom.mjs";
|
|
|
|
/**
|
|
* @name addDays
|
|
* @category Day Helpers
|
|
* @summary Add the specified number of days to the given date.
|
|
*
|
|
* @description
|
|
* Add the specified number of days 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 days to be added.
|
|
*
|
|
* @returns The new date with the days added
|
|
*
|
|
* @example
|
|
* // Add 10 days to 1 September 2014:
|
|
* const result = addDays(new Date(2014, 8, 1), 10)
|
|
* //=> Thu Sep 11 2014 00:00:00
|
|
*/
|
|
export function addDays(date, amount) {
|
|
const _date = toDate(date);
|
|
if (isNaN(amount)) return constructFrom(date, NaN);
|
|
if (!amount) {
|
|
// If 0 days, no-op to avoid changing times in the hour before end of DST
|
|
return _date;
|
|
}
|
|
_date.setDate(_date.getDate() + amount);
|
|
return _date;
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default addDays;
|