subYears.js 1.1 KB

12345678910111213141516171819202122232425262728293031323334
  1. import { addYears } from "./addYears.js";
  2. /**
  3. * The {@link subYears} function options.
  4. */
  5. /**
  6. * @name subYears
  7. * @category Year Helpers
  8. * @summary Subtract the specified number of years from the given date.
  9. *
  10. * @description
  11. * Subtract the specified number of years from the given date.
  12. *
  13. * @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).
  14. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  15. *
  16. * @param date - The date to be changed
  17. * @param amount - The amount of years to be subtracted.
  18. * @param options - An object with options
  19. *
  20. * @returns The new date with the years subtracted
  21. *
  22. * @example
  23. * // Subtract 5 years from 1 September 2014:
  24. * const result = subYears(new Date(2014, 8, 1), 5)
  25. * //=> Tue Sep 01 2009 00:00:00
  26. */
  27. export function subYears(date, amount, options) {
  28. return addYears(date, -amount, options);
  29. }
  30. // Fallback for modularized imports:
  31. export default subYears;