Skip to content

intervalEngulfsUnix

intervalEngulfsUnix(aStart: string | number, aEnd: string | number, bStart: string | number, bEnd: string | number): boolean
import { intervalEngulfsUnix } from "@northguild/gmt/unix/interval";

Return true when interval B is fully contained within interval A — every instant of B

  • falls within A.
  • Compares numeric Unix epoch values directly.
  • Equivalent to 4-argument intervalContainsUnix(aStart, aEnd, bStart, bEnd).
  • Returns false if either interval is invalid (start > end).
  • Returns false on invalid input (non-numeric types, non-finite values).
Parameter Type Description
aStart string | number Unix epoch value (seconds or milliseconds) — outer interval start
aEnd string | number Unix epoch value (seconds or milliseconds) — outer interval end
bStart string | number Unix epoch value (seconds or milliseconds) — inner interval start
bEnd string | number Unix epoch value (seconds or milliseconds) — inner interval end

true if B is fully contained in A, or false on invalid input

intervalEngulfsUnix(0, 1700000000, 1500000000, 1600000000) // true
intervalEngulfsUnix(0, 1700000000, 0, 1700000000) // true (equal intervals)
intervalEngulfsUnix(0, 1700000000, 0, 1500000000) // true
intervalEngulfsUnix(1500000000, 1600000000, 0, 1700000000) // false
intervalEngulfsUnix(NaN, 1700000000, 1500000000, 1600000000) // false

unix/interval/intervalEngulfsUnix.ts