UNPKG

682 BTypeScriptView Raw
1/**
2 * @name isYesterday
3 * @category Day Helpers
4 * @summary Is the given date yesterday?
5 * @pure false
6 *
7 * @description
8 * Is the given date yesterday?
9 *
10 * @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).
11 *
12 * @param date - The date to check
13 *
14 * @returns The date is yesterday
15 *
16 * @example
17 * // If today is 6 October 2014, is 5 October 14:00:00 yesterday?
18 * const result = isYesterday(new Date(2014, 9, 5, 14, 0))
19 * //=> true
20 */
21export declare function isYesterday<DateType extends Date>(
22 date: DateType | number | string,
23): boolean;