123456789101112131415161718192021222324252627282930313233 |
- import isSameDay from "../isSameDay/index.js";
- import subDays from "../subDays/index.js";
- import requiredArgs from "../_lib/requiredArgs/index.js";
- /**
- * @name isYesterday
- * @category Day Helpers
- * @summary Is the given date yesterday?
- * @pure false
- *
- * @description
- * Is the given date yesterday?
- *
- * > ⚠️ 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 yesterday
- * @throws {TypeError} 1 argument required
- *
- * @example
- * // If today is 6 October 2014, is 5 October 14:00:00 yesterday?
- * var result = isYesterday(new Date(2014, 9, 5, 14, 0))
- * //=> true
- */
- export default function isYesterday(dirtyDate) {
- requiredArgs(1, arguments);
- return isSameDay(dirtyDate, subDays(Date.now(), 1));
- }
|