date-fns-jalali/differenceInCalendarMonths.js

Modern JavaScript date utility library for jalali calendar

"use strict";
exports.differenceInCalendarMonths = differenceInCalendarMonths;
var _index = require("./toDate.js");
var _index2 = require("./_core/getMonth.js");
var _index3 = require("./_core/getFullYear.js");

/**
 * @name differenceInCalendarMonths
 * @category Month Helpers
 * @summary Get the number of calendar months between the given dates.
 *
 * @description
 * Get the number of calendar months between the given dates.
 *
 * @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).
 *
 * @param dateLeft - The later date
 * @param dateRight - The earlier date
 *
 * @returns The number of calendar months
 *
 * @example
 * // How many calendar months are between 31 January 2014 and 1 September 2014?
 * const result = differenceInCalendarMonths(
 *   new Date(2014, 8, 1),
 *   new Date(2014, 0, 31)
 * )
 * //=> 8
 */
function differenceInCalendarMonths(dateLeft, dateRight) {
  const _dateLeft = (0, _index.toDate)(dateLeft);
  const _dateRight = (0, _index.toDate)(dateRight);

  const yearDiff =
    (0, _index3.getFullYear)(_dateLeft) - (0, _index3.getFullYear)(_dateRight);
  const monthDiff =
    (0, _index2.getMonth)(_dateLeft) - (0, _index2.getMonth)(_dateRight);

  return yearDiff * 12 + monthDiff;
}