timepiece/node_modules/date-fns/isToday.d.ts

24 lines
654 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name isToday
* @category Day Helpers
* @summary Is the given date today?
* @pure false
*
* @description
* Is the given date today?
*
* @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 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<DateType extends Date>(
date: DateType | number | string,
): boolean;