Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
29 lines
850 B
Plaintext
29 lines
850 B
Plaintext
import { addMonths } from "./addMonths.mjs";
|
|
|
|
/**
|
|
* @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).
|
|
*
|
|
* @param date - The date to be changed
|
|
* @param amount - The amount of years to be added.
|
|
*
|
|
* @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) {
|
|
return addMonths(date, amount * 12);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default addYears;
|