Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

index.js 1.7 KiB

3 år sedan
1234567891011121314151617181920212223242526272829303132333435363738394041
  1. import toDate from '../toDate/index.js';
  2. import differenceInCalendarMonths from '../differenceInCalendarMonths/index.js';
  3. import compareAsc from '../compareAsc/index.js';
  4. import requiredArgs from '../_lib/requiredArgs/index.js';
  5. /**
  6. * @name differenceInMonths
  7. * @category Month Helpers
  8. * @summary Get the number of full months between the given dates.
  9. *
  10. * @description
  11. * Get the number of full months between the given dates.
  12. *
  13. * ### v2.0.0 breaking changes:
  14. *
  15. * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
  16. *
  17. * @param {Date|Number} dateLeft - the later date
  18. * @param {Date|Number} dateRight - the earlier date
  19. * @returns {Number} the number of full months
  20. * @throws {TypeError} 2 arguments required
  21. *
  22. * @example
  23. * // How many full months are between 31 January 2014 and 1 September 2014?
  24. * var result = differenceInMonths(new Date(2014, 8, 1), new Date(2014, 0, 31))
  25. * //=> 7
  26. */
  27. export default function differenceInMonths(dirtyDateLeft, dirtyDateRight) {
  28. requiredArgs(2, arguments);
  29. var dateLeft = toDate(dirtyDateLeft);
  30. var dateRight = toDate(dirtyDateRight);
  31. var sign = compareAsc(dateLeft, dateRight);
  32. var difference = Math.abs(differenceInCalendarMonths(dateLeft, dateRight));
  33. dateLeft.setMonth(dateLeft.getMonth() - sign * difference); // Math.abs(diff in full months - diff in calendar months) === 1 if last calendar month is not full
  34. // If so, result must be decreased by 1 in absolute value
  35. var isLastMonthNotFull = compareAsc(dateLeft, dateRight) === -sign;
  36. var result = sign * (difference - isLastMonthNotFull); // Prevent negative zero
  37. return result === 0 ? 0 : result;
  38. }