index.js 1.1 KB

12345678910111213141516171819202122232425262728293031
  1. import toInteger from "../_lib/toInteger/index.js";
  2. import addMonths from "../addMonths/index.js";
  3. import requiredArgs from "../_lib/requiredArgs/index.js";
  4. /**
  5. * @name addYears
  6. * @category Year Helpers
  7. * @summary Add the specified number of years to the given date.
  8. *
  9. * @description
  10. * Add the specified number of years to the given date.
  11. *
  12. * ### v2.0.0 breaking changes:
  13. *
  14. * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
  15. *
  16. * @param {Date|Number} date - the date to be changed
  17. * @param {Number} amount - the amount of years to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
  18. * @returns {Date} the new date with the years added
  19. * @throws {TypeError} 2 arguments required
  20. *
  21. * @example
  22. * // Add 5 years to 1 September 2014:
  23. * const result = addYears(new Date(2014, 8, 1), 5)
  24. * //=> Sun Sep 01 2019 00:00:00
  25. */
  26. export default function addYears(dirtyDate, dirtyAmount) {
  27. requiredArgs(2, arguments);
  28. var amount = toInteger(dirtyAmount);
  29. return addMonths(dirtyDate, amount * 12);
  30. }