24 lines
685 B
TypeScript
24 lines
685 B
TypeScript
|
/**
|
||
|
|
* @name isFuture
|
||
|
|
* @category Common Helpers
|
||
|
|
* @summary Is the given date in the future?
|
||
|
|
* @pure false
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date in the future?
|
||
|
|
*
|
||
|
|
* @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).
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
*
|
||
|
|
* @returns The date is in the future
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If today is 6 October 2014, is 31 December 2014 in the future?
|
||
|
|
* const result = isFuture(new Date(2014, 11, 31))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export declare function isFuture<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): boolean;
|