@burglekitt/gmt
Version:
Temporal-based date and time utilities with timezone support and polyfill integration
22 lines (21 loc) • 973 B
TypeScript
/**
* Return true when `value` is strictly after today, per the system clock
* and system timeZone.
*
* - `value === today` returns false — "future" means strictly after, not
* on-or-after.
* - Compares against `getToday()`, so this depends on the **system clock and
* system timeZone**. A caller needing determinism should use
* `isZonedFuture` with an explicit timeZone, or compare against an
* explicit reference with `isAfterDate`.
* - Returns false if `value` is invalid or the system timeZone is unavailable.
*
* @param value ISO PlainDate string
* @returns true if `value` is after today, false on invalid input
*
* @example isFuture("2024-03-16") // true, if today is 2024-03-15
* @example isFuture("2024-03-15") // false, if today is 2024-03-15 (equal is not future)
* @example isFuture("2024-03-14") // false, if today is 2024-03-15
* @example isFuture("invalid") // false
*/
export declare function isFuture(value: string): boolean;