isValidDateTimeRange

Signature

isValidDateTimeRange(props: { value1: string; value2: string; options?: { allowEqual?: boolean; }; }): boolean

Return true if value1 and value2 form a valid datetime range — both parseable as ISO PlainDateTime strings and value1 before value2.

• Both inputs must be ISO 8601 datetime strings (e.g. "2024-01-01T10:00:00"), as isValidDateTime accepts, annotations included.
• Invalid input, malformed strings, or leap-second strings return false.

Options

props

The two values to compare and how equal values are treated

Option	Type	Default	Description
value1	string	Required	The start of the range, an ISO PlainDateTime string.
value2	string	Required	The end of the range, an ISO PlainDateTime string.
options?	object	None. Equal values are not a valid range.	The settings for the comparison. It must be an object or omitted; any other value, null included, returns false.
options.allowEqual?	boolean	false	Whether value1 equal to value2 is a valid range. false requires value1 to be before value2.

Returns

boolean indicating whether the datetime range is valid

Examples

import { isValidDateTimeRange } from "@northguild/gmt/plain/validate";

isValidDateTimeRange({ value1: "2024-01-01T10:00:00", value2: "2024-12-31T23:59:59" }) // true

value1value2

output

 

Source

plain/validate/isValidDateTimeRange.ts