date/addYears.ts

/**
 *
 * @memberof module:Date
 * @function addYears
 *
 * @description Returns the date with the sum of the years, by default the date is `new Date()`
 *
 * @param {!number} yearsToAdd - The number of years to increase
 * @param {Date} [date=new Date()] - The date to which years are added, by default is `new Date()`
 * @returns {Date} The date with the years added
 *
 * @example
 * import { addYears } from 'main-fns';
 *
 * const myDate = new Date(1995, 05, 27);
 * console.log(addYears(1, myDate)); // Date(1996, 05, 27)
 */
export function addYears(yearsToAdd: number, date: Date = new Date()): Date {
    const result = new Date(date);
    result.setFullYear(result.getFullYear() + Math.abs(yearsToAdd));

    return result;
}