Vlad Durnea
cffdf8af86
Some checks failed
CI/CD Pipeline / unit-tests (push) Failing after 1m16s
CI/CD Pipeline / integration-tests (push) Failing after 2m32s
CI/CD Pipeline / lint (push) Successful in 5m22s
CI/CD Pipeline / e2e-tests (push) Has been skipped
CI/CD Pipeline / build (push) Has been skipped
30 lines
789 B
JavaScript
30 lines
789 B
JavaScript
import { constructNow } from "./constructNow.mjs";
|
|
import { isSameDay } from "./isSameDay.mjs";
|
|
|
|
/**
|
|
* @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 function isToday(date) {
|
|
return isSameDay(date, constructNow(date));
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default isToday;
|