subYears.cjs 1.1 KB

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