date-fns-jalali/isSameMonth.mjs

Modern JavaScript date utility library for jalali calendar

import { toDate } from "./toDate.mjs";
import { getMonth as coreGetMonth } from "./_core/getMonth.mjs";
import { getFullYear as coreGetFullYear } from "./_core/getFullYear.mjs";

/**
 * @name isSameMonth
 * @category Month Helpers
 * @summary Are the given dates in the same month (and year)?
 *
 * @description
 * Are the given dates in the same month (and year)?
 *
 * @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 first date to check
 * @param dateRight - The second date to check
 *
 * @returns The dates are in the same month (and year)
 *
 * @example
 * // Are 2 September 2014 and 25 September 2014 in the same month?
 * const result = isSameMonth(new Date(2014, 8, 2), new Date(2014, 8, 25))
 * //=> true
 *
 * @example
 * // Are 2 September 2014 and 25 September 2015 in the same month?
 * const result = isSameMonth(new Date(2014, 8, 2), new Date(2015, 8, 25))
 * //=> false
 */
export function isSameMonth(dateLeft, dateRight) {
  const _dateLeft = toDate(dateLeft);
  const _dateRight = toDate(dateRight);
  return (
    coreGetFullYear(_dateLeft) === coreGetFullYear(_dateRight) &&
    coreGetMonth(_dateLeft) === coreGetMonth(_dateRight)
  );
}

// Fallback for modularized imports:
export default isSameMonth;