date-fns-jalali/isFirstDayOfMonth.mjs

Modern JavaScript date utility library for jalali calendar

import { toDate } from "./toDate.mjs";
import { getDate as coreGetDate } from "./_core/getDate.mjs";

/**
 * @name isFirstDayOfMonth
 * @category Month Helpers
 * @summary Is the given date the first day of a month?
 *
 * @description
 * Is the given date the first day of a month?
 *
 * @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 the first day of a month
 *
 * @example
 * // Is 1 September 2014 the first day of a month?
 * const result = isFirstDayOfMonth(new Date(2014, 8, 1))
 * //=> true
 */
export function isFirstDayOfMonth(date) {
  return coreGetDate(toDate(date)) === 1;
}

// Fallback for modularized imports:
export default isFirstDayOfMonth;