Source: isYesterday/index.js

  1. import isSameDay from '../isSameDay/index'
  2. import subDays from '../subDays/index'
  3. import requiredArgs from '../_lib/requiredArgs/index'
  5. /**
  6.  * @name isYesterday
  7.  * @category Day Helpers
  8.  * @summary Is the given date yesterday?
  9.  * @pure false
  10.  *
  11.  * @description
  12.  * Is the given date yesterday?
  13.  *
  14.  * > ⚠️ Please note that this function is not present in the FP submodule as
  15.  * > it uses `Date.now()` internally hence impure and can't be safely curried.
  16.  *
  17.  * ### v2.0.0 breaking changes:
  18.  *
  19.  * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
  20.  *
  21.  * @param {Date|Number} date - the date to check
  22.  * @returns {Boolean} the date is yesterday
  23.  * @throws {TypeError} 1 argument required
  24.  *
  25.  * @example
  26.  * // If today is 6 October 2014, is 5 October 14:00:00 yesterday?
  27.  * var result = isYesterday(new Date(2014, 9, 5, 14, 0))
  28.  * //=> true
  29.  */
  30. export default function isYesterday(dirtyDate) {
  31.   requiredArgs(1, arguments)
  33.   return isSameDay(dirtyDate, subDays(Date.now(), 1))
  34. }