date/subtractYears.ts

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

    return result;
}