index.js 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = differenceInCalendarYears;
  7. var _index = _interopRequireDefault(require("../toDate/index.js"));
  8. var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  9. /**
  10. * @name differenceInCalendarYears
  11. * @category Year Helpers
  12. * @summary Get the number of calendar years between the given dates.
  13. *
  14. * @description
  15. * Get the number of calendar years between the given dates.
  16. *
  17. * @param {Date|Number} dateLeft - the later date
  18. * @param {Date|Number} dateRight - the earlier date
  19. * @returns {Number} the number of calendar years
  20. * @throws {TypeError} 2 arguments required
  21. *
  22. * @example
  23. * // How many calendar years are between 31 December 2013 and 11 February 2015?
  24. * const result = differenceInCalendarYears(
  25. * new Date(2015, 1, 11),
  26. * new Date(2013, 11, 31)
  27. * )
  28. * //=> 2
  29. */
  30. function differenceInCalendarYears(dirtyDateLeft, dirtyDateRight) {
  31. (0, _index2.default)(2, arguments);
  32. var dateLeft = (0, _index.default)(dirtyDateLeft);
  33. var dateRight = (0, _index.default)(dirtyDateRight);
  34. return dateLeft.getFullYear() - dateRight.getFullYear();
  35. }
  36. module.exports = exports.default;