addYears

A utility function to add or subtract a specified number of years to/from a given date.
> addYears(years: number, date: Date = new Date()): Date
Parameters
  • years (number): The number of years to add. Pass a negative number to subtract years.
  • date (Date, optional): The base date to modify. Defaults to the current date (new Date()).
  • Returns: A new Date object with the specified number of years added.

Example

import { addYears } from "@explita/daily-toolset";

// Add 5 years to the current date
const futureDate = addYears(5);
console.log(futureDate); // e.g., 2029-11-22T00:00:00.000Z

// Subtract 3 years from a specific date
const pastDate = addYears(-3, new Date("2024-11-22"));
console.log(pastDate); // e.g., 2021-11-22T00:00:00.000Z

// Add 10 years to a custom date
const customDate = new Date("2000-01-01");
const result = addYears(10, customDate);
console.log(result); // e.g., 2010-01-01T00:00:00.000Z

Use Cases

  • Calculating dates for long-term planning or projections.
  • Adjusting dates for multi-year scheduling tasks.
  • Computing anniversaries, contract end dates, or similar events.