isPast

Signature

isPast(value: string): boolean

import { isPast } from "@northguild/gmt/plain/compare";

Return true when value is strictly before today, per the system clock

• and system timeZone.
• value === today returns false — “past” means strictly before, not on-or-before.
• Compares against getToday(), so this depends on the system clock and system timeZone. A caller needing determinism should use isZonedPast with an explicit timeZone, or compare against an explicit reference with isBeforeDate.
• Returns false if value is invalid or the system timeZone is unavailable.

Parameters

Parameter	Type	Description
value	string	ISO PlainDate string

Returns

true if value is before today, false on invalid input

Examples

isPast("2024-03-14") // true, if today is 2024-03-15
isPast("2024-03-15") // false, if today is 2024-03-15 (equal is not past)
isPast("2024-03-16") // false, if today is 2024-03-15
isPast("invalid") // false

Source

plain/compare/isPast.ts