UNPKG

685 BTypeScriptView Raw
1/**
2 * @name isFuture
3 * @category Common Helpers
4 * @summary Is the given date in the future?
5 * @pure false
6 *
7 * @description
8 * Is the given date in the future?
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 in the future
15 *
16 * @example
17 * // If today is 6 October 2014, is 31 December 2014 in the future?
18 * const result = isFuture(new Date(2014, 11, 31))
19 * //=> true
20 */
21export declare function isFuture<DateType extends Date>(
22 date: DateType | number | string,
23): boolean;