UNPKG

508 BTypeScriptView Raw
1import type { DateArg } from "./types.js";
2/**
3 * @name isFuture
4 * @category Common Helpers
5 * @summary Is the given date in the future?
6 * @pure false
7 *
8 * @description
9 * Is the given date in the future?
10 *
11 * @param date - The date to check
12 *
13 * @returns The date is in the future
14 *
15 * @example
16 * // If today is 6 October 2014, is 31 December 2014 in the future?
17 * const result = isFuture(new Date(2014, 11, 31))
18 * //=> true
19 */
20export declare function isFuture(date: DateArg<Date> & {}): boolean;