/* eslint-disable eslint-comments/no-unlimited-disable */
/* eslint-disable */
// @ts-nocheck

import { constructFrom } from '../constructFrom/index.ts';
import { constructNow } from '../constructNow/index.ts';
import { isSameDay } from '../isSameDay/index.ts';
import type { ContextOptions, DateArg } from '../types.ts';

/**
 * The {@link isToday} function options.
 */
export interface IsTodayOptions extends ContextOptions<Date> {}

/**
 * @name isToday
 * @category Day Helpers
 * @summary Is the given date today?
 * @pure false
 *
 * @description
 * Is the given date today?
 *
 * @param date - The date to check
 * @param options - An object with options
 *
 * @returns The date is today
 *
 * @example
 * // If today is 6 October 2014, is 6 October 14:00:00 today?
 * const result = isToday(new Date(2014, 9, 6, 14, 0))
 * //=> true
 */
export function isToday(date: DateArg<Date> & {}, options?: IsTodayOptions | undefined): boolean {
  return isSameDay(constructFrom(options?.in || date, date), constructNow(options?.in || date));
}

/* eslint-enable */