70 lines
2.1 KiB
JavaScript
70 lines
2.1 KiB
JavaScript
|
import { addDays } from "./addDays.js";
|
||
|
|
import { addMonths } from "./addMonths.js";
|
||
|
|
import { constructFrom } from "./constructFrom.js";
|
||
|
|
import { toDate } from "./toDate.js";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link add} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name add
|
||
|
|
* @category Common Helpers
|
||
|
|
* @summary Add the specified years, months, weeks, days, hours, minutes, and seconds to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Add the specified years, months, weeks, days, hours, minutes, and seconds to the given date.
|
||
|
|
*
|
||
|
|
* @typeParam DateType - The `Date` type the function operates on. Gets inferred from passed arguments. Allows using extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
||
|
|
* @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
||
|
|
*
|
||
|
|
* @param date - The date to be changed
|
||
|
|
* @param duration - The object with years, months, weeks, days, hours, minutes, and seconds to be added.
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The new date with the seconds added
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Add the following duration to 1 September 2014, 10:19:50
|
||
|
|
* const result = add(new Date(2014, 8, 1, 10, 19, 50), {
|
||
|
|
* years: 2,
|
||
|
|
* months: 9,
|
||
|
|
* weeks: 1,
|
||
|
|
* days: 7,
|
||
|
|
* hours: 5,
|
||
|
|
* minutes: 9,
|
||
|
|
* seconds: 30,
|
||
|
|
* })
|
||
|
|
* //=> Thu Jun 15 2017 15:29:20
|
||
|
|
*/
|
||
|
|
export function add(date, duration, options) {
|
||
|
|
const {
|
||
|
|
years = 0,
|
||
|
|
months = 0,
|
||
|
|
weeks = 0,
|
||
|
|
days = 0,
|
||
|
|
hours = 0,
|
||
|
|
minutes = 0,
|
||
|
|
seconds = 0,
|
||
|
|
} = duration;
|
||
|
|
|
||
|
|
// Add years and months
|
||
|
|
const _date = toDate(date, options?.in);
|
||
|
|
const dateWithMonths =
|
||
|
|
months || years ? addMonths(_date, months + years * 12) : _date;
|
||
|
|
|
||
|
|
// Add weeks and days
|
||
|
|
const dateWithDays =
|
||
|
|
days || weeks ? addDays(dateWithMonths, days + weeks * 7) : dateWithMonths;
|
||
|
|
|
||
|
|
// Add days, hours, minutes, and seconds
|
||
|
|
const minutesToAdd = minutes + hours * 60;
|
||
|
|
const secondsToAdd = seconds + minutesToAdd * 60;
|
||
|
|
const msToAdd = secondsToAdd * 1000;
|
||
|
|
|
||
|
|
return constructFrom(options?.in || date, +dateWithDays + msToAdd);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default add;
|