date-fns-jalali/isLeapYear.mjs

Modern JavaScript date utility library for jalali calendar

import { toDate } from "./toDate.mjs";
import { isLeapYear as coreIsLeapYear } from "./_core/isLeapYear.mjs";
import { getFullYear as coreGetFullYear } from "./_core/getFullYear.mjs";

/**
 * @name isLeapYear
 * @category Year Helpers
 * @summary Is the given date in the leap year?
 *
 * @description
 * Is the given date in the leap 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 date - The date to check
 *
 * @returns The date is in the leap year
 *
 * @example
 * // Is 1 September 2012 in the leap year?
 * const result = isLeapYear(new Date(2012, 8, 1))
 * //=> true
 */
export function isLeapYear(date) {
  const _date = toDate(date);
  const year = coreGetFullYear(_date);
  return coreIsLeapYear(year);
}

// Fallback for modularized imports:
export default isLeapYear;