35 lines
1,001 B
JavaScript
35 lines
1,001 B
JavaScript
|
import { addMonths } from "./addMonths.js";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link addYears} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name addYears
|
||
|
|
* @category Year Helpers
|
||
|
|
* @summary Add the specified number of years to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Add the specified number of years 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).
|
||
|
|
* @typeParam ResultDate - The result `Date` type.
|
||
|
|
*
|
||
|
|
* @param date - The date to be changed
|
||
|
|
* @param amount - The amount of years to be added.
|
||
|
|
* @param options - The options
|
||
|
|
*
|
||
|
|
* @returns The new date with the years added
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Add 5 years to 1 September 2014:
|
||
|
|
* const result = addYears(new Date(2014, 8, 1), 5)
|
||
|
|
* //=> Sun Sep 01 2019 00:00:00
|
||
|
|
*/
|
||
|
|
export function addYears(date, amount, options) {
|
||
|
|
return addMonths(date, amount * 12, options);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default addYears;
|