Skip to main content
Module

x/date_fns/isToday/index.ts

date-fns Deno package
Very Popular
Latest
File
import isSameDay from '../isSameDay/index.ts'import requiredArgs from '../_lib/requiredArgs/index.ts'
/** * @name isToday * @category Day Helpers * @summary Is the given date today? * @pure false * * @description * Is the given date today? * * > ⚠️ Please note that this function is not present in the FP submodule as * > it uses `Date.now()` internally hence impure and can't be safely curried. * * ### v2.0.0 breaking changes: * * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes). * * @param {Date|Number} date - the date to check * @returns {Boolean} the date is today * @throws {TypeError} 1 argument required * * @example * // If today is 6 October 2014, is 6 October 14:00:00 today? * var result = isToday(new Date(2014, 9, 6, 14, 0)) * //=> true */export default function isToday(dirtyDate: Date | number): boolean { requiredArgs(1, arguments)
return isSameDay(dirtyDate, Date.now())}