12345678910111213141516171819202122232425262728 |
- import type { ContextOptions, DateArg } from "./types.js";
- /**
- * 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 declare function isToday(
- date: DateArg<Date> & {},
- options?: IsTodayOptions | undefined,
- ): boolean;
|