intervalContainsUnix

Signature

intervalContainsUnix(intervalStart: string | number, intervalEnd: string | number, pointOrStart: string | number, pointEnd?: string | number): boolean

import { intervalContainsUnix } from "@northguild/gmt/unix/interval";

Return true when pointOrStart falls within the interval [intervalStart, intervalEnd]

• (3-arg), or when the inner interval [innerStart, innerEnd] is fully contained within the outer interval [intervalStart, intervalEnd] (4-arg).
• Compares numeric Unix epoch values directly.
• Always-inclusive boundaries: start <= point <= end.
• Returns false if intervalStart > intervalEnd (invalid outer interval).
• Returns false if innerStart > innerEnd in 4-arg mode (invalid inner interval).
• Returns false on invalid input (non-numeric types, non-finite values).

Parameters

Parameter	Type	Description
intervalStart	string | number	Unix epoch value (seconds or milliseconds) — outer interval start
intervalEnd	string | number	Unix epoch value (seconds or milliseconds) — outer interval end
pointOrStart	string | number	Unix epoch value for the point (3-arg) or inner start (4-arg)
pointEnd	string | number	optional Unix epoch value for the inner interval end (4-arg mode)

Returns

true if the point or inner interval is contained, or false on invalid input

Examples

intervalContainsUnix(0, 1700000000, 170000000) // true
intervalContainsUnix(0, 1700000000, 170000000, 1500000000) // true
intervalContainsUnix(1700000000, 0, 170000000) // false
intervalContainsUnix(0, 1700000000, 170000000, 15000000) // false
intervalContainsUnix(NaN, 1700000000, 170000000) // false
intervalContainsUnix("0", "1700000000", "170000000") // true

Source

unix/interval/intervalContainsUnix.ts