28 lines
818 B
JavaScript
28 lines
818 B
JavaScript
|
import isSameDay from "../isSameDay/index.js";
|
|||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
|||
|
|
/**
|
|||
|
|
* @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.
|
|||
|
|
*
|
|||
|
|
* @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?
|
|||
|
|
* const result = isToday(new Date(2014, 9, 6, 14, 0))
|
|||
|
|
* //=> true
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
export default function isToday(dirtyDate) {
|
|||
|
|
requiredArgs(1, arguments);
|
|||
|
|
return isSameDay(dirtyDate, Date.now());
|
|||
|
|
}
|