diff options
| author | Pinapelz <yukais@pinapelz.com> | 2025-06-28 17:26:46 -0700 |
|---|---|---|
| committer | Pinapelz <yukais@pinapelz.com> | 2025-06-28 17:43:56 -0700 |
| commit | e4fa1e69e7ebfb627c7198fd1a9881e9327ec4d4 (patch) | |
| tree | 06284a538a6008eca75051399e47db4e5d50301c /node_modules/date-fns/esm/isToday/index.js | |
initial commit: scaffolding
Diffstat (limited to 'node_modules/date-fns/esm/isToday/index.js')
| -rw-r--r-- | node_modules/date-fns/esm/isToday/index.js | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/isToday/index.js b/node_modules/date-fns/esm/isToday/index.js new file mode 100644 index 0000000..a80bfcb --- /dev/null +++ b/node_modules/date-fns/esm/isToday/index.js @@ -0,0 +1,27 @@ +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()); +}
\ No newline at end of file |
