isBetweenTime

Signature

isBetweenTime(time: string, start: string, end: string, options?: { inclusiveStart?: boolean; inclusiveEnd?: boolean; }): boolean

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

Return true when time is between start and end (inclusive by default).

• Uses Temporal.PlainTime.compare to compare times.
• Returns false if start > end (invalid range).
• Returns false if any input is invalid.
• Use options.inclusiveStart and options.inclusiveEnd to control boundary inclusivity.
• Note: PlainTime comparison does not account for day overflow.

Parameters

Parameter	Type	Description
time	string	ISO PlainTime string to check
start	string	ISO PlainTime string for the start of the range
end	string	ISO PlainTime string for the end of the range

Options

options

Option	Type	Default
inclusiveStart?	boolean	—
inclusiveEnd?	boolean	—

Returns

boolean indicating whether time is between start and end

Examples

isBetweenTime("12:34:56", "12:00:00", "13:00:00") // true
isBetweenTime("12:34:56", "12:34:56", "13:00:00") // true
isBetweenTime("12:34:56", "12:34:57", "13:00:00") // false
isBetweenTime("12:34:56", "12:00:00", "12:34:56") // true
isBetweenTime("12:34:56", "12:00:00", "12:34:55") // false
isBetweenTime("invalid", "12:00:00", "13:00:00") // false
isBetweenTime("12:34:56", "invalid", "13:00:00") // false
isBetweenTime("12:34:56", "12:00:00", "invalid") // false

Source

plain/compare/isBetweenTime.ts