isValidUnixRange

Signature

isValidUnixRange({ value1, value2, options, }: { value1: string | number; value2: string | number; options?: { allowEqual?: boolean; }; }): boolean

import { isValidUnixRange } from "@northguild/gmt/unix/validate";

Return true if value1 and value2 form a valid Unix range — both finite numbers

• and value1 <= value2.
• Both inputs must be numbers (or numeric strings that coerce to finite numbers).
• Equal value1 === value2 is valid when options.allowEqual is true.
• Non-finite values (NaN, Infinity) return false.

Parameters

Parameter	Type	Description
value1	``	first Unix epoch value (seconds or milliseconds)
value2	``	second Unix epoch value (seconds or milliseconds)
options	``	optional allowEqual flag

Returns

boolean indicating whether the Unix range is valid

Examples

isValidUnixRange({ value1: 0, value2: 1700000000 }) // true
isValidUnixRange({ value1: 1700000000, value2: 0 }) // false
isValidUnixRange({ value1: 1000, value2: 1000, options: { allowEqual: true } }) // true

Source

unix/validate/isValidUnixRange.ts