/* eslint-disable eslint-comments/no-unlimited-disable */ /* eslint-disable */ // @ts-nocheck import { toDate } from '../toDate/index.ts'; import type { ContextOptions, DateArg } from '../types.ts'; /** * The {@link isFirstDayOfMonth} function options. */ export interface IsFirstDayOfMonthOptions extends ContextOptions {} /** * @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? * * @param date - The date to check * @param options - An object with options * * @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: DateArg & {}, options?: IsFirstDayOfMonthOptions | undefined): boolean { return toDate(date, options?.in).getDate() === 1; } /* eslint-enable */